Wikibooks Automatische Vorlagen/ Dokumentation

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

Zielgruppe: Nutzer, die die automatischen Vorlagen verstehen und ergänzen wollen

Allgemeine Hinweise

Die folgenden Hinweise gelten einheitlich für alle Vorlagen.

Zum besseren Verständnis der Beschreibung bietet es sich an, die Dokumentation und den Quelltext einer Vorlage in zwei Fenstern des Browsers zu öffnen und nebeneinander zu lesen.

Vorlagendefinition

Jede Vorlage wird durch <includeonly> zusammengefasst; das unterdrückt missverständliche Anzeigen auf der Vorlagenseite.

Die Vorlagen für den direkten Aufruf benutzen die Vorlage:Dokumentation, alle anderen Vorlagen einheitlich die Vorlage:AutoVorlagen Dokumentation. Die Beschreibung verweist vor allem auf dieses „Buch“.

Die Vorlagen werden wie folgt kategorisiert:

• Die Vorlagen für den direkten Aufruf gehören zu Kategorie:Vorlage für Navigation und Kategorie:Vorlage für Buchgestaltung.
• Alle weiteren Vorlagen gehören zur Kategorie:Vorlage für technische Aufgaben.
• Die Datenseiten gehören zur Kategorie:Bucheigene Vorlage.

Parameter

Die Vorlagen für den direkten Aufruf werden ohne Parameter benutzt. Die benötigten Parameter – vor allem der Verweis auf die Datenseiten – werden bestimmt und an die weiteren Vorlagen übergeben. Genaueres steht bei der Beschreibung der einzelnen Vorlagen.

Der Parameter datenB steht für die Buchdaten, der Parameter datenT für Teildaten. Wenn beides möglich ist oder die Unterscheidung nicht erforderlich ist, wird auch daten verwendet.

Werte abfragen

Eine Konstruktion wie {{:{{{daten}}} | max }} wird ständig in verschiedenen Varianten benutzt. Grundsätzlich wird dabei eine Datenseite wie eine Vorlage verwendet und holt über die dort enthaltene switch-Anweisung das „Ergebnis“ zum gewünschten Wert. Beispiele:

{{:{{{datenB}}}| max }}	bestimmt das Maximum max der Teile eines Buches.
{{:{{{datenT}}}| max }}	bestimmt das Maximum max der Einträge eines Teils.
{{:{{{datenT}}}| Zielgruppe }}	holt den entsprechenden Text zu einem Teil.
{{:{{{daten}}}| 3 }}	bestimmt den Namen des 3. Eintrags.
{{:{{{daten}}}| 2/4 }}	holt aus dem 2. Bereich eines Teils den Namen des 4. Kapitels.
{{:{{{daten}}}| 2/4i }}	holt zu diesem Kapitel eine zusätzliche Inhaltsangabe.

Hinweis zu if:true

In vielen Situationen wird ein gesuchter Wert zusätzlich in {{#if: true| <wert> }} eingebunden. Das sorgt dafür, dass Leerzeichen und Zeilenumbrüche aus den daten nicht als Teil des Wertes übernommen werden. Nur auf diesem Weg kann die gesamte Gliederung eines Buches übersichtlich eingetragen und gleichzeitig korrekt ausgewertet werden.

Hinweis zu ifexpr

An vielen Stellen gibt es 20 Wiederholungen mit einer Abfrage der folgenden Art:

{{#ifexpr: 7 <= {{{max}}} | <Anweisungen> }}

Diese werden verschachtelt: Wenn es zu einer Nummer keinen Teil und kein Kapitel gibt, dann auch nicht zu allen folgenden Nummern. Nebenbei ermöglicht diese Verschachtelung auch eine übersichtlichere Eingabe in den Datenseiten, ohne dass die Anzeige zu Lücken führt.

Vorgaben

Wenn eine Datenseite erstmals benutzt wird, werden mithilfe der preload-Funktion aus speziellen Musterdaten Vorschläge für einen sinnvollen Aufbau geholt.

Für Kapitel wird auf Vorschläge verzichtet: Das Einbinden einer Preload-Seite wäre in diesem Fall relativ umständlich. Außerdem sind nur die beiden Zeilen für die Navigation einzutragen; das geht mit den Kopiervorlagen oder auch manuell.

Mögliche Verbesserungen

Jeweils 20 Wiederholungen sollten durch Schleifen ersetzt werden. Das ist zurzeit nicht möglich, weil sie bei der Wiki-Software nicht freigegeben sind.

Mit Variablen könnte auf Vorlagen, die mit Start bezeichnet sind, verzichtet werden; und viele Prüfungen wären einfacher. Aber auch Variable sind nicht möglich.

---

Vorbereitung

Hier wird die Arbeitsweise der folgenden Vorlagen für das Inhaltsverzeichnis beschrieben:

• AutoInhalt
• AutoInhalt Start
• AutoInhalt Ebene2 Start

Beachte auch die allgemeinen Hinweise zur Definition der Vorlagen, zu Parametern und zur Abfrage von Werten.

Struktur

Die folgende Darstellung zeigt stark vereinfacht den Zusammenhang der Vorlagen.

		AutoInhalt
		⇓
⌈		AutoInhalt Start
⇓		⇓
⇓		AutoInhalt Ebene2 Start
⇓		⇓
AutoInhalt Ebene1	⇐	AutoInhalt Ebene2	⇒	AutoInhalt Ebene3

AutoInhalt Verwendung in der Seite, die das Inhaltsverzeichnis anzeigen soll Aufruf ohne Parameter Diese Vorlage registriert einige feste Werte und übergibt diese als Parameter an die nächste Vorlage.
AutoInhalt Start Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel		Bedeutung
datenB	Wikibooks Automatische Vorlagen/ Vorlage:Daten		Verweis auf die Buchdaten
name1	Wikibooks Automatische Vorlagen		erster Bestandteil des Seitennamens, also der Name des Buches
max	4		Anzahl der Teile oder Kapitel des Buches
Mit diesen Angaben werden die folgenden Prüfungen ausgeführt.
Ergebnis	Ebenen	Situation	Erläuterung
Sind die Buchdaten vorhanden?
Nein		allgemein	Keine Anzeige möglich, es gibt einen entsprechenden Hinweis. Die folgenden Schritte werden übergangen; weiter bei der Anzeige der Links zum Buch.
Ja		allgemein	Weitere Prüfungen und Anzeigen folgen.
Ist die Gliederung in Teile vorgesehen?
Ja	3 oder 4	Buch mit Teilen	Für jeden der (maximal 20) Teile wird die Vorlage AutoInhalt Ebene2 Start mit passenden Parametern aufgerufen.
Nein	2	Buch ohne Teile	Einmalig wird die Vorlage AutoInhalt Ebene1 mit passenden Parametern aufgerufen (Erläuterung im nächsten Kapitel).
Anzeige der Links zum Buch
Die Vorlagen AutoInhalt dienen auch dazu, den Export für LaTeX/PDF zu steuern. Die Links werden aber nur beim wirklichen Inhaltsverzeichnis benötigt; dazu gibt es die nächste Prüfung: Wird {{AutoInhalt}} von der LaTeX-Seite aus aufgerufen?
Ja		allgemein	Keine Anzeige, die nachfolgenden Links innerhalb eines <div>...</div>-Abschnitts werden übergangen.
Nein		allgemein	Die folgenden Links werden angezeigt: Gesamtes Buch: Aufruf einer Seite Druckversion für das gesamte Buch Buchdaten: Direkter Aufruf dieser Seite zum Bearbeiten unter Verwendung der Preload-Funktion LaTeX-/PDF-Export: Aufruf einer speziellen Übersichtsseite zum Erzeugen einer PDF-Version
AutoInhalt Ebene2 Start Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel		Bedeutung
datenB	Wikibooks Automatische Vorlagen/ Vorlage:Daten		Verweis auf die Buchdaten
name1	Wikibooks Automatische Vorlagen		erster Bestandteil des Seitennamens, also der Name des Buches
name2	Dokumentation		Name des Teils als zweiter Bestandteil des Seitennamens
nr2	3		laufende Nummer des Teils innerhalb des Buches
Daraus werden eine Reihe weiterer Angaben bestimmt; dies sind dann die Parameter zum Aufruf der Vorlage AutoInhalt Ebene2 (Erläuterung im nächsten Kapitel)

---

Anzeige

Hier wird die Arbeitsweise der folgenden Vorlagen für das Inhaltsverzeichnis genauer beschrieben:

• AutoInhalt Ebene1 – die Anzeige der Kapitel für ein Buch ohne Teile
• AutoInhalt Ebene2 – die Anzeige eines Teils des Buches
• AutoInhalt Ebene3 – die Anzeige eines Bereichs in einem Teil
• dazu die einzelnen Abschnitte der Anzeige:
  • AutoInhalt Link
  • AutoVorlagen Vorspann
  • AutoInhalt Zeile

Beachte auch die allgemeinen Hinweise zur Definition der Vorlagen, zu Parametern und zur Abfrage von Werten.

Allgemeine Angaben

Die folgenden Werte werden sowohl auf Ebene 1 (bei einem Buch ohne Teile) als auch auf Ebene 2 (bei den Teilen eines Buches) wiederholt für Prüfungen und Anzeigen benutzt. Sie werden deshalb in gleicher Weise übergeben:

• für die Vorlage AutoInhalt Ebene1 durch AutoInhalt Start
• für die Vorlage AutoInhalt Ebene2 durch AutoInhalt Ebene2 Start

Name	Beispiel	Bedeutung
kapE	Einführung	Name eines einleitenden Kapitels, sofern vorhanden
kapZ	Zusammenfassung	Name eines abschließenden Kapitels, sofern vorhanden
bild	Zeichen 206.svg	Name einer Bilddatei, soweit gewünscht
gruppe	Alle Leser	Angabe der Zielgruppe für das Buch, sofern vorgesehen
ziel	Allgemeines Verständnis	Angabe des Lernziels für das Buch, sofern vorgesehen
inhalt	Ein kurzer Text	Kurzinhalt für das Buch, sofern vorgesehen
image	240px	Größe für ein Bild (eine Datei) innerhalb des Inhaltsverzeichnisses
latex	latex=on	im normalen Inhaltsverzeichnis nicht vorhanden nur als Hinweis darauf vorgesehen, wenn es sich um den Export-Inhalt handelt

AutoInhalt Ebene1

Die Vorlage AutoInhalt Ebene1 gilt für ein Buch ohne Teile. Sie wird durch die Vorlage AutoInhalt Start aufgerufen – siehe die Erläuterungen im vorigen Kapitel.

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel	Bedeutung
daten	Wikibooks Automatische Vorlagen/ Vorlage:Daten	Verweis auf die Buchdaten
name1	Wikibooks Automatische Vorlagen	erster Bestandteil des Seitennamens, also der Name des Buches
max	4	Anzahl der Kapitel des Buches
link	Wikibooks Automatische Vorlagen	erster Bestandteil des Seitennamens, also der Name des Buches Damit ein Kapitel immer auf die gleiche Weise angezeigt werden kann (gleichgültig, von welcher Ebene aus), wird dieser zusätzliche Parameter verwendet.
Außerdem werden die obengenannten allgemeinen Angaben übergeben.
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt.
Ergebnis	Situation	Erläuterung
Wird {{AutoInhalt}} von der LaTeX-Seite aus aufgerufen? Die Prüfung wird aus syntaktischen Gründen mehrfach benötigt.
Anzeige eines Rahmens um das Inhaltsverzeichnis mit einer Überschrift (nicht bei der LaTeX-Seite)
Ist eine der allgemeinen Angaben bild, gruppe, ziel, inhalt vorgesehen?
Nein		Die betreffenden Teile werden nicht benutzt; die Vorlage Vorspann wird übergangen.
Ja	mit Vorspann	Die Vorlage Vorspann wird angezeigt; als Parameter werden diese vier Angaben übergeben – zur Dokumentation siehe den Hinweis am Ende dieser Seite.
Ist der Wert max, also die Anzahl der Kapitel angegeben?
Nein	Kapitel fehlen	Die Kapitel können nicht angezeigt werden, sondern nur ein Hinweis. Im Übrigen ist das Ende der Anzeige erreicht.
Ja	Kapitel anzeigen	Alle Kapitel werden angezeigt.
kapE	Einleitung	Sofern vorgesehen, wird ein Link auf das einleitende Kapitel angezeigt.
1 bis 20	Kapitel	Für jedes der (maximal 20) Kapitel wird die Vorlage AutoInhalt Zeile mit passenden Parametern aufgerufen – Dokumentation siehe unten.
kapz	Zusammenfassung	Sofern vorgesehen, wird ein Link auf das abschließende Kapitel angezeigt.

AutoInhalt Ebene2

Die Vorlage AutoInhalt Ebene2 gilt für Teile eines Buchs. Sie wird aufgerufen durch die Vorlage AutoInhalt Start – siehe die Erläuterungen im vorigen Kapitel.

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel	Bedeutung
datenT	Wikibooks Automatische Vorlagen/ Vorlage:Daten Dokumentation	Verweis auf die Teildaten
name1	Wikibooks Automatische Vorlagen	erster Bestandteil des Seitennamens, also der Name des Buches
name2	Wikibooks Automatische Vorlagen	der Name des Teils als zweiter Bestandteil des Seitennamens für ein Kapitel
nr2	3	laufende Nummer des Teils in der Liste der Teile für das Buch
max	4	Anzahl der Einträge (Bereiche oder Kapitel) innerhalb des Teils
link	Wikibooks Automatische Vorlagen/ Dokumentation	die ersten beiden Bestandteile des Seitennamens, also der vollständige Name des Teils Damit ein Kapitel immer auf die gleiche Weise angezeigt werden kann (gleichgültig, von welcher Ebene aus), wird dieser zusätzliche Parameter verwendet.
Außerdem werden die obengenannten allgemeinen Angaben übergeben.
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt.
Ergebnis	Situation	Erläuterung
Wird {{AutoInhalt}} von der LaTeX-Seite aus aufgerufen? Die Prüfung wird aus syntaktischen Gründen mehrfach benötigt. Je nach Situation werden manche Anzeigen unterdrückt, andere sind vorgesehen oder werden angepasst.
Anzeige des Kopfes für den Teil (bei der LaTeX-Seite stark verkürzt) ein Rahmen um diese Anzeige ein Link auf die Seite Gesamter Teil eine Überschrift sowie ein Anker für die {{AutoNavigation}}
Sind die Teildaten vorhanden?
Nein	allgemein	Keine Anzeige möglich, es gibt einen entsprechenden Hinweis. Die folgenden Schritte werden übergangen; weiter bei der Anzeige des Links zu den Teildaten.
Ja	allgemein	Weitere Prüfungen und Anzeigen folgen.
Ist eine der allgemeinen Angaben bild, gruppe, ziel, inhalt vorgesehen?
Nein		Die betreffenden Teile werden nicht benutzt; die Vorlage Vorspann wird übergangen.
Ja	mit Vorspann	Die Vorlage Vorspann wird angezeigt; als Parameter werden diese vier Angaben übergeben – zur Dokumentation siehe den Hinweis am Ende dieser Seite.
kapE	Einleitung	Sofern vorgesehen, wird ein Link auf das einleitende Kapitel angezeigt.
Ist die Gliederung in Bereiche vorgesehen? Das wird dadurch festgestellt, ob ein Kapitel durch den Parameter 1/1 vorgesehen ist. Das wäre das erste Kapitel im ersten Bereich. Wenn ja, gibt es die Untergliederung in Bereeich, andernfalls nicht.
Ja	Teil mit Bereichen	Für jeden der (maximal 20) Bereiche wird die Vorlage AutoInhalt Ebene3 mit passenden Parametern aufgerufen – Dokumentation im nächsten Abschnitt.
Nein	Teil mit Kapiteln	Nach einer Zwischenüberschrift werden alle Kapitel angezeigt.
1 bis 20	Kapitel	Für jedes der (maximal 20) Kapitel wird die Vorlage AutoInhalt Zeile mit passenden Parametern aufgerufen – Dokumentation siehe unten.
kapz	Zusammenfassung	Sofern vorgesehen, wird ein Link auf das abschließende Kapitel angezeigt.
Anzeige des Links zu den Teildaten (nicht auf der LaTeX-Seite) Teildaten: Direkter Aufruf dieser Seite zum Bearbeiten unter Verwendung der Preload-Funktion

AutoInhalt Ebene3

Die Vorlage AutoInhalt Ebene3 gilt für einen Bereich in einem Teil des Buchs. Sie wird aufgerufen durch die Vorlage AutoInhalt Ebene2 (siehe oben).

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel	Bedeutung
daten	Wikibooks Automatische Vorlagen/ Vorlage:Daten Dokumentation	Verweis auf die Teildaten
nr	2	laufende Nummer des Bereichs in diesen Teildaten
name		der Name des Bereichs, also der dritte Bestandteil des Seitennamens für ein Kapitel
link	Wikibooks Automatische Vorlagen/ Dokumentation	die ersten beiden Bestandteile des Seitennamens, also der vollständige Name des Teils Aus praktischen Gründen wurde es einfacher, wenn der Name des Teils und nicht der Name des Bereichs übergeben wird.
max	3	Anzahl der Kapitel innerhalb des Bereichs
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt.
Ergebnis	Situation	Erläuterung
Anzeige einer Zwischenüberschrift
Ist eine Inhaltsangabe des Bereichs vorgesehen? Dies wird durch einen der Parameter 1i für den ersten Bereich, 2i für den zweiten Bereich usw. – allgemein also durch {{{nr}}}i – festgestellt.
Ja	Inhaltsangabe	In diesem Fall wird ein Kurzinhalt angezeigt.
Ist der Wert max, also die Anzahl der Kapitel angegeben?
Nein	Kapitel fehlen	Die Kapitel können nicht angezeigt werden, sondern nur ein Hinweis. Im Übrigen ist das Ende der Anzeige erreicht.
Ja	Kapitel anzeigen	Alle Kapitel werden angezeigt.
1 bis 20	Kapitel	Für jedes der (maximal 20) Kapitel wird die Vorlage AutoInhalt Zeile mit passenden Parametern aufgerufen – siehe unten.

AutoInhalt Link

Diese Vorlage zeigt den Link auf einen gesamten Teil an. Sie wird durch die Vorlage AutoInhalt Ebene2 (siehe oben) aufgerufen. Wegen der besseren Übersichtlichkeit steht dieser Link in einer eigenen Vorlage.

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel	Bedeutung
link	Wikibooks Automatische Vorlagen/ Dokumentation	die ersten beiden Bestandteile des Seitennamens, also der vollständige Name des Teils
text	Gesamter Teil	Anzeigetext für den Teil, der auf die Funktion hinweist
Mit diesen Angaben werden die folgenden Maßnahmen erledigt. Anzeige eines Rahmens Anzeige eines Links

AutoInhalt Zeile

Diese Vorlage zeigt den Link auf ein einzelnes Kapitel an. Sie wird aufgerufen durch eine der Vorlagen AutoInhalt Ebene1, AutoInhalt Ebene2 oder AutoInhalt Ebene3 (siehe oben).

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel	Bedeutung
name		der Name des Kapitels, also der letzte Bestandteil des Seitennamens
link	Wikibooks Automatische Vorlagen/ Dokumentation	alle vorherigen Bestandteile des Seitennamens, also der Name des Buchs, Teils oder Bereichs
inhalt	Kurzhinweis	ein ergänzender Hinweis auf den Inhalt oder die Bedeutung des Kapitels
Mit diesen Angaben werden die folgenden Maßnahmen erledigt. Aufzählungszeichen Link auf das Kapitel (in Wiki-Syntax), zusammengesetzt aus den Parametern link und name sofern vorgesehen, durch inhalt ein ergänzender Hinweis, abgetrennt durch einen Gedankenstrich

AutoVorlagen Vorspann

Diese Vorlage wird an mehreren Stellen benötigt; sie wird im letzten Kapitel Ergänzende Vorlagen der Dokumentation beschrieben.

---

Musterdaten

Beim erstmaligen Erstellen von Buchdaten und Teildaten werden Musterseiten als Inhalt vorgeschlagen. Diese werden hier kurz beschrieben.

Preload Buchdaten

Die Vorlage AutoInhalt Preload Buchdaten wird im Inhaltsverzeichnis mit der Seite Buch/ Vorlage:Daten – also Buchdaten – verknüpft: Sofern diese Seite beim erstmaligen Aufruf noch nicht vorhanden ist, erhält sie den vorbereiteten Inhalt (ein paar allgemeine Angaben sowie drei Teile).

Die Verwendung wird in der Einleitung sowie den ersten beiden Kapiteln dieses Teils beschrieben.

Preload Teildaten

Die Vorlage AutoInhalt Preload Teildaten wird im Inhaltsverzeichnis mit den Seiten Buch/ Vorlage:Daten Teil – also allen Teildaten – verknüpft: Sofern eine solche Seite beim erstmaligen Aufruf noch nicht vorhanden ist, erhält sie den hier vorbereiteten Inhalt (das „Gerüst“ für allgemeine Angaben sowie drei Kapitel).

Die Verwendung wird in den weiteren Kapiteln des Teils Verwendung beschrieben.

Allgemeines

Die Verknüpfung von <onlyinclude>, <includeonly>, <noinclude> dient dazu, dass auch nach der Anzeige ein <noinclude>-Abschnitt vorhanden ist.

Die Beschreibung benutzt die gleiche Dokumentation wie die automatischen Vorlagen und verweist auf dieses „Buch“.

Beide Vorlagen gehören zur Kategorie:Vorlage für technische Aufgaben.

---

Vorbereitung

Hier wird die Arbeitsweise der folgenden Vorlagen für die Navigation genauer beschrieben:

• AutoNavigation
• AutoNavigation Start
• AutoNavigation Vorbereitung
• AutoNavigation Ebene3 Start

Beachte auch die allgemeinen Hinweise zur Definition dieser Vorlagen, zu Parametern und zur Abfrage von Werten.

Struktur

Die folgende Darstellung zeigt stark vereinfacht den Zusammenhang der Vorlagen.

AutoNavigation
⇓
AutoNavigation Start
⇓
AutoNavigation Vorbereitung	⇒	AutoNavigation Ebene3 Start
⇓	⇒	⇓	⇒	⇓
AutoNavigation Ebene2	⇒	AutoNavigation Ebene3	⇒	AutoNavigation Ebene4
⇓	⇒	⇓	⇒	⇓
	AutoNavigation Anzeige

Einleitung, Zusammenfassung

Die Namen eines einleitenden und eines abschließenden Kapitels innerhalb des Buchs oder eines Teils werden immer mit der Zusatzvorlage GetStandard geholt. Überall dort, wo kapE, kapZ bestimmt wird, wird diese Vorlage mit den richtigen Parametern eingebunden.

AutoNavigation

Die Vorlage AutoNavigation wird in allen Seiten verwendet, die die Navigation anzeigen sollen, also in jedem Kapitel sowie den Seiten Gesamter Teil. Sie wird ohne Parameter aufgerufen.

Diese Vorlage registriert einige feste Werte und übergibt diese als Parameter an die nächste Vorlage.

AutoNavigation Start

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel		Bedeutung
daten	Wikibooks Automatische Vorlagen/ Vorlage:Daten		Verweis auf die Buchdaten
name1	Wikibooks Automatische Vorlagen		erster Bestandteil des Seitennamens, also der Name des Buches
name2	Dokumentation		zweiter Bestandteil des Seitennamens, also der Name des Buches
name3			dritter Bestandteil des Seitennamens, also der Name des Buches (nicht vorhanden bei einem Buch ohne Teile und bei den Gesamtseiten eines Teils)
name4			vierter Bestandteil des Seitennamens, also der Name des Buches (nur vorhanden bei Kapiteln eines Bereichs)
kapE	Einführung		Name eines einleitenden Kapitels, sofern vorhanden (nur möglich bei einem Buch ohne Teile)
kapZ	Zusammenfassung		Name eines abschließenden Kapitels, sofern vorhanden
max2	4		Anzahl der Teile oder Kapitel des Buches (also die möglichen Einträge auf Ebene 2)
Mit diesen Angaben werden weitere Angaben bestimmt und an die nächste Vorlage Vorbereitung übergeben.

AutoNavigation Vorbereitung

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel		Bedeutung
Die Parameter daten, name1, name2, name3, name4, max2, kapE, kapZ werden einfach weitergereicht.
buch	Wikibooks Automatische Vorlagen/ Inhaltsverzeichnis		Verweis auf die Seite mit dem Inhaltsverzeichnis
nr2	3		Nummer des Teils oder Kapitels, unter der die Angabe zu name2 in den Buchdaten steht; dazu wird die ergänzende Vorlage GetNumber benutzt – Dokumentation im letzten Kapitel des Teils.
var	4		Variante, für die die Navigation benötigt wird Kapitel in einem Buch ohne Teile Gesamter Teil für ein Buch mit Teilen Kapitel in einem Teil eines Buches ohne Bereich, kann aber auch die Einleitung oder Zusammenfassung sein Kapitel in einem Bereich eines Teils
Mit diesen Angaben werden die folgenden Prüfungen ausgeführt.
Ergebnis	Ebenen	Situation	Erläuterung
Handelt es sich um eine Seite mit 2 Ebenen (Variante 1 oder 2) oder nicht, also um ein Kapitel in einem Buch mit Teilen (Variante 3 oder 4)?
Ja	1 oder 2	einfache Struktur	Die AutoNavigation zur Ebene2 kann angezeigt werden. Die vorhandenen Parameter werden weitergereicht; nicht benötigte Parameter werden ignoriert; weitere Parameter werden bestimmt. Weiter mit der Anzeige durch die Vorlage AutoNavigation Ebene2 – Dokumentation im nächsten Kapitel.
Nein	3 oder 4	genauere Struktur	Für die Struktur mit 3 oder 4 Ebenen werden weitere Informationen benötigt. Die vorhandenen Parameter werden an die nächste Vorlage Ebene3 Start weitergereicht; weitere Parameter werden dazu bestimmt.

AutoNavigation Ebene3 Start

Dieser Vorlage werden die folgenden Informationen übergeben:
Name	Beispiel		Bedeutung
Die Parameter var, name1, name2, name3, name4, nr2, max2 werden einfach weitergereicht. datenB erhält den Wert des bisherigen Parameters daten.
datenT	Wikibooks Automatische Vorlagen/ Vorlage:Daten Dokumentation		Verweis auf die Teildaten
link	Wikibooks Automatische Vorlagen/ Dokumentation		der vollständige Name des Teils
kapE	Einführung		Name eines einleitenden Kapitels des Teils, sofern vorhanden
kapZ	Zusammenfassung		Name eines abschließenden Kapitels des Teils, sofern vorhanden
max3	4		Anzahl der Bereiche oder Kapitel des Teils (also die möglichen Einträge auf Ebene 3)
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt.
Ergebnis	Ebenen	Situation	Erläuterung
Handelt es sich um ein Kapitel mit 3 Ebenen (also direkt innerhalb eines Teils) oder mit 4 Ebenen (also innerhalb eines Bereichs)?
	3	in einem Teil	Die AutoNavigation zur Ebene3 kann angezeigt werden. Die vorhandenen Parameter werden weitergereicht; weitere Parameter können einfach bestimmt werden. Weiter mit der Anzeige durch die Vorlage AutoNavigation Ebene3 – Dokumentation im nächsten Kapitel.
	4	in einem Bereich	Die AutoNavigation zur Ebene4 kann angezeigt werden. Die vorhandenen Parameter werden weitergereicht; weitere Parameter müssen aber – teilweise umständlich – noch bestimmt werden. Weiter mit der Anzeige durch die Vorlage AutoNavigation Ebene4 – Dokumentation im nächsten Kapitel.

---

Anzeige

Hier wird die Arbeitsweise der folgenden Vorlagen für das Inhaltsverzeichnis genauer beschrieben:

• AutoNavigation Ebene2
• AutoNavigation Ebene3
• AutoNavigation Ebene4
• AutoNavigation Anzeige

Beachte auch die allgemeinen Hinweise zur Definition dieser Vorlagen, zu Parametern und zur Abfrage von Werten.

Arbeitsablauf

Zur Erinnerung: In den Vorlagen zur Vorbereitung (siehe das vorige Kapitel) wird die Variante als Parameter var bestimmt. Abhängig davon gibt es mit unterschiedlichen Parametern jeweils eine eigene Vorlage zur Anzeige:

Variante	Situation	Verwendung
1	Buch ohne Teile	Die Vorlage AutoNavigation Vorbereitung ruft die Vorlage AutoNavigation Ebene2 auf.
2	Gesamter Teil
3	Kapitel im Teil	Die Vorlage AutoNavigation Ebene3 Start ruft die Vorlage AutoNavigation Ebene3 auf.
4	Kapitel im Bereich	Die Vorlage AutoNavigation Ebene3 Start ruft die Vorlage AutoNavigation Ebene4 auf.

Dabei werden immer diejenigen Parameter übergeben, die im Abschnitt Einheitliche Angaben aufgeführt werden. Weitere Parameter stehen bei den einzelnen Vorlagen.

Jede dieser Vorlagen bestimmt Links für die Vorlage AutoNavigation Anzeige, die die eigentliche Anzeige auslöst:

• regal, reihe, buch, hoch
• start, ende, zurück, weiter

Einheitliche Angaben

Die folgenden Werte werden von den Vorlagen zur Vorbereitung (voriges Kapitel) bei allen Varianten in gleicher oder ähnlicher Weise an die einzelnen Vorlagen übergeben.

Name	Variante	Kurzhinweis	Bedeutung
var	immer		Variante für die Art der Navigation, die benötigt wird
daten	1, 2	datenB	Datenseite des Buchs
	3, 4	datenT	Datenseite des Teils
link	1, 2	name1	Seitenname des Buchs
	3, 4	name1/ name2	Seitenname des Teils
name1	immer	Buchname	erster Bestandteil des Seitennamens
name2	1	Kapitel	zweiter Bestandteil des Seitennamens
	2, 3, 4	Name des Teils
nr2	immer	laufende Nummer	Nummer des Kapitels oder Teils in den Buchdaten
min2	immer	Minimum	kleinstmöglicher Eintrag auf Ebene 2: 0 – bei einem Buch ohne Teil, wenn ein einleitendes Kapitel vorhanden ist 1 – in allen anderen Fällen
max2	immer	Maximum	größtmöglicher Eintrag auf Ebene 2: max2 + 1 – bei einem Buch ohne Teil, wenn ein abschließendes Kapitel vorhanden ist max2 – in allen anderen Fällen
kapE	1	Einführung	Name eines einleitenden Kapitels zum Buch, sofern vorhanden
	2		nicht verwendet
	3, 4	Einführung	Name eines einleitenden Kapitels zum Teil, sofern vorhanden
kapZ	1	Zusammenfassung	Name eines abschließenden Kapitels zum Buch, sofern vorhanden
	2		nicht verwendet
	3, 4	Zusammenfassung	Name eines abschließenden Kapitels zum Teil, sofern vorhanden

AutoNavigation Ebene2

Diese Vorlage wird von AutoNavigation Vorbereitung zu den Varianten 1 und 2 aufgerufen. Neben den einheitlichen Angaben werden keine weiteren Parameter übergeben.

Diese Vorlage bestimmt die Links zur Navigation mit den folgenden Prüfungen und übergibt sie als Parameter an die Vorlage AutoNavigation Anzeige.

Name des Links	Bedingungen	Erläuterung
regal, reihe, buch	soweit vorhanden	Die Werte werden aus den Buchdaten geholt.
hochLink, hochText	Variante 1	Kapitel eines Buchs: keine Anzeige sinnvoll
	Variante 2	Teile eines Buchs: Verweis auf den Teil im Inhaltsverzeichnis
start	Verweis auf den Anfang des Buches
	Buch mit Einleitung	Verweis auf das einleitende Kapitel
	andernfalls	Verweis auf das erste Kapitel bzw. den ersten Teil des Buches
ende	Verweis auf das Ende des Buches
	Buch mit Zusammenfassung	Verweis auf das abschließende Kapitel
	andernfalls	Verweis auf das letzte Kapitel bzw. den letzten Teil des Buches
zurück	am Anfang des Buches	keine Anzeige beim ersten oder zweiten Kapitel bzw. Teil des Buches – durch start gibt es bereits eine geeignete Anzeige
	andernfalls	Verweis auf das vorherige Kapitel bzw. den vorherigen Teil des Buches
weiter	am Ende des Buches	keine Anzeige beim letzten oder vorletzten Kapitel bzw. Teil des Buches – durch ende gibt es bereits eine geeignete Anzeige
	andernfalls	Verweis auf das folgende Kapitel bzw. den folgenden Teil des Buches

AutoNavigation Ebene3

Diese Vorlage wird von AutoNavigation Ebene3 Start zur Variante 3 aufgerufen.

Neben den einheitlichen Angaben werden die folgenden Parameter übergeben.
Name	Kurzhinweis	Bedeutung
regal, reihe, buch	soweit vorhanden	Die Werte wurden bereits aus den Buchdaten geholt.
name3	Name des Kapitels	dritter Bestandteil des Seitennamens
nr3	laufende Nummer	Nummer des Kapitels in den Teildaten mit Hilfe der ergänzenden Vorlage GetNumber – Dokumentation im letzten Kapitel des Teils
min3	Minimum	kleinstmöglicher Eintrag auf Ebene 3: 0 – wenn ein einleitendes Kapitel zu diesem Teil vorhanden ist 1 – wenn ein solches Kapitel fehlt
max3	Maximum	größtmöglicher Eintrag auf Ebene 3: max3 + 1 – bei einem Teil, wenn ein abschließendes Kapitel vorhanden ist max3 – wenn ein solches Kapitel fehlt
3i	Text	Zusammenfassung des Kapitelinhaltes
3randnotiz	Wert „1“	Ausblenden des Hinweises „Es sind noch keine Kapitel zu diesem Bereich registriert.”
bereiche	Name des ersten Kapitels 1/1 als Hinweis darauf, dass der Teil in Bereiche untergliedert ist
Diese Vorlage bestimmt die Links zur Navigation mit den folgenden Prüfungen und übergibt sie als Parameter an die Vorlage AutoNavigation Anzeige.
Name des Links	Bedingungen	Erläuterung
regal, reihe, buch	soweit vorhanden	Die Werte werden direkt weitergegeben.
hochLink, hochText	immer	Verweis auf den aktuellen Teil im Inhaltsverzeichnis
start	Verweis auf den Anfang des aktuellen Teils
	Teil mit Einleitung	Verweis auf das einleitende Kapitel
	andernfalls	Verweis auf das erste Kapitel des Teils oder des ersten Bereichs
ende	Verweis auf das Ende des aktuellen Teils
	Teil mit Zusammenfassung	Verweis auf das abschließende Kapitel
	andernfalls	Verweis auf das letzte Kapitel des Teils oder des letzten Bereichs
zurück	Teil mit Bereichen	Bei Variante 3 kann dies nur in der Einleitung oder Zusammenfassung vorkommen, dann gilt: entfällt im einleitenden Kapitel des Teils zurück zum letzten Kapitel des letzten Bereichs mit der Zusatzvorlage Bereich kapL – Dokumentation im nächsten Kapitel
	am Anfang des Teils	keine Anzeige beim ersten oder zweiten Kapitel des Teils – durch start gibt es bereits eine geeignete Anzeige
	andernfalls	Verweis auf das vorherige Kapitel des Teils
weiter	Teil mit Bereichen	Bei Variante 3 kann dies nur in der Einleitung oder Zusammenfassung vorkommen, dann gilt: entfällt im abschließenden Kapitel des Teils weiter zum ersten Kapitel des ersten Bereichs
	am Ende des Teils	keine Anzeige beim letzten oder vorletzten Kapitel des Teils – durch ende gibt es bereits eine geeignete Anzeige
	andernfalls	Verweis auf das folgende Kapitel des Teils

AutoNavigation Ebene4

Diese Vorlage wird von AutoNavigation Ebene3 Start zur Variante 4 aufgerufen.

Neben den einheitlichen Angaben werden die folgenden Parameter übergeben.
Name	Kurzhinweis	Bedeutung
regal, reihe, buch	soweit vorhanden	Die Werte wurden aus den Buchdaten geholt.
name3	Name des Bereichs	dritter Bestandteil des Seitennamens
name4	Name des Kapitels	vierter Bestandteil des Seitennamens
nr3	laufende Nummer	Nummer des Bereichs in den Teildaten mit Hilfe der ergänzenden Vorlage GetNumber benutzt – Dokumentation im letzten Kapitel des Teils
nr4	laufende Nummer	Nummer des Kapitels innerhalb dieses Bereichs ebenso mit der Vorlage GetNumber
max3	Maximum	größtmöglicher Eintrag auf Ebene 3, also Anzahl der Bereiche innerhalb des Teils Anders als im vorigen Abschnitt zur Vorlage AutoNavigation Ebene3 wird dieser Wert nicht geändert – unabhängig davon, ob die Zusammenfassung vorhanden ist oder nicht
max4	Maximum	größtmöglicher Eintrag auf Ebene 4, also Anzahl der Kapitel innerhalb des Bereichs
Diese Vorlage bestimmt die Links zur Navigation mit den folgenden Prüfungen und übergibt sie als Parameter an die Vorlage AutoNavigation Anzeige.
Name des Links	Bedingungen	Erläuterung
regal, reihe, buch	soweit vorhanden	Die Werte werden direkt weitergegeben.
hochLink, hochText	immer	Verweis auf den aktuellen Teil im Inhaltsverzeichnis
start	Verweis auf den Anfang des aktuellen Teils
	Teil mit Einleitung	Verweis auf das einleitende Kapitel
	andernfalls	Verweis auf das erste Kapitel des ersten Bereichs im Teil
ende	Verweis auf das Ende des aktuellen Teils
	Teil mit Zusammenfassung	Verweis auf das abschließende Kapitel
	andernfalls	Verweis auf das letzte Kapitel des letzten Bereichs im Teil
zurück	nr4 > 1	gehe zurück zum vorigen Kapitel im gleichen Bereich: Wenn (nr4=2) und (nr3=1) gilt, wird so geprüft: Wenn die Einleitung des Teils vorhanden ist, dann ist das vorige Kapitel das Kapitel 1/1 des Teils. Wenn die Einleitung fehlt, dann ist das vorige Kapitel gleichzeitig der Anfang des Teils und wird bereits durch start angezeigt; also entfällt eine weitere Anzeige bei zurück. In allen anderen Fällen geht es zum Kapitel nr3/(nr4-1).
	nr4 = 1	gehe zurück zum letzten Kapitel im vorigen Bereich: Bei (nr3=1) gibt es keinen vorigen Bereich; also entfällt die Anzeige. In allen anderen Fällen wird das letzte Kapitel des vorigen Bereichs mit der Zusatzvorlage Bereich kapL geholt – Dokumentation im nächsten Kapitel.
weiter	nr4 < max4	gehe weiter zum nächsten Kapitel im gleichen Bereich: Wenn (nr4=(max4-1)) und (nr3=max3) gilt, wird so geprüft: Wenn die Zusammenfassung des Teils vorhanden ist, dann ist das nächste Kapitel das Kapitel max3/max4 des Teils. Wenn die Zusammenfassung fehlt, dann ist das nächste Kapitel gleichzeitig das Ende des Teils und wird bereits durch ende angezeigt; also entfällt eine weitere Anzeige bei weiter. In allen anderen Fällen geht es zum Kapitel nr3/(nr4+1).
	nr4 = max4	gehe weiter zum ersten Kapitel im nächsten Bereich: Bei (nr3=max3) gibt es keinen nächsten Bereich; also entfällt die Anzeige. In allen anderen Fällen wird das erste Kapitel des nächsten Bereichs geholt, also das Kapitel (nr3+1)/1 des Teils.

AutoNavigation Anzeige

Die vorstehenden Vorlagen erzeugen zur Navigation Links auf die folgenden Seiten.

Name des Links	Variante	Bedeutung
regal	allgemein	Verweis auf das Regal, sofern das in den Buchdaten eingetragen wird
reihe	allgemein	Verweis auf die Buchreihe, sofern das in den Buchdaten eingetragen wird
buch	immer	Verweis auf das Inhaltsverzeichnis des Buches insgesamt
hochLink, hochText	1	entfällt bei einem Buch ohne Teile
	2, 3, 4	Verweis auf einen Teil des Inhaltsverzeichnisses (genauer: auf einen Anker)
start	1	Verweis auf das erste Kapitel des Buchs
	2	Verweis auf den ersten Teil des Buchs
	3, 4	Verweis auf das erste Kapitel oder die Einleitung des Teils
ende	1	Verweis auf das letzte Kapitel des Buchs
	2	Verweis auf den letzten Teil des Buchs
	3, 4	Verweis auf das letzte Kapitel oder die Zusammenfassung des Teils
zurück	2	Verweis auf den vorigen Teil des Buches
	1, 3, 4	Verweis auf das vorige Kapitel des Buchs oder Teils
	entfällt	Kein Link, wenn der Verweis identisch ist mit dem start-Eintrag
weiter	2	Verweis auf den nächsten Teil des Buches
	1, 3, 4	Verweis auf das nächste Kapitel des Buchs oder Teils
	entfällt	Kein Link, wenn der Verweis identisch ist mit dem ende-Eintrag
Diese Informationen werden an eine konkrete Vorlage zur Navigation weitergeleitet, diese übernimmt die eigentliche Anzeige: Wenn für das Buch eine Vorlage mit dem Namen Buch/ Vorlage:Navigation gibt, wird diese verwendet. Andernfalls wird die Vorlage Navigation Regal Reihe Buch verwendet; deren Darstellung ist besonders flexibel.
regal, reihe, buch, hochLink, hochText		Diese Links werden direkt weitergegeben; der Anzeigetext wird nach einem Standard festgelegt.
start, ende, zurück, weiter		Diese Links werden direkt weitergegeben; der Anzeigetext wird mit der Zusatzvorlage Anzeige Text aus dem Link herausgeholt – Dokumentation im nächsten Kapitel.
	1, 2, 3	Name des Kapitels
	4	Name von Bereich und Kapitel

---

Zusatzvorlagen

In diesem Kapitel werden Vorlagen beschrieben, die an mehreren Stellen für die automatische Navigation verwendet werden.

Bereich kapL

Mit der Vorlage AutoNavigation Bereich kapL wird der Name des letzten Kapitels eines Bereichs geholt. Dazu wird eine eigene Vorlage verwendet, weil die Anzahl der Kapitel noch nicht bekannt ist, sondern erst festgestellt werden muss.

Diese Vorlage wird von den Vorlagen AutoNavigation Ebene3 und AutoNavigation Ebene4 wiederholt verwendet. Dies wird im vorigen Kapitel beschrieben.

Dieser Vorlage werden die folgenden Informationen als Parameter übergeben:
Name	Inhalt	Bedeutung
daten	datenT	Datenseite des Teils mit den Listen aller Bereiche und Kapitel
nr	2	Nummer des gewünschten Bereichs
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt. Bitte beachte den allgemeinen Hinweis zu #if:true.
Abfrage		Bedeutung
allgemein		Die gesuchten Namen werden durch Schrägstriche zu einem Link zusammengesetzt.
{{:{{{daten}}}|{{{nr}}}}}		bestimme den Namen des Bereichs nr
{{:{{{daten}}}|{{{nr}}}max}}		bestimme das Maximum max4 der Kapitel zum Bereich nr
{{:{{{daten}}}|{{{nr}}}/max4}}		bestimme den Namen des Kapitels nr/max4

Anzeige Text

Mit der Vorlage AutoNavigation Anzeige Text wird der Anzeigetext für einen Link bestimmt. Diese Vorlage wird von der Vorlage AutoNavigation Anzeige wiederholt verwendet. Dies wird im vorigen Kapitel beschrieben.

Dieser Vorlage werden die folgenden Informationen als Parameter übergeben:
Nr	Name	Inhalt	Bedeutung
1	link	Angabe eines Links	der vollständige Name der Seite, auf die verwiesen werden soll
2	var	2, 3, 4	Anzahl der Bestandteile des Namens (das entspricht weitgehend der Variante für die Navigation)
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt.
Abfrage		Teilaufgabe	Bedeutung
#ifeq: {{{2}}} | 2		{{#titleparts: {{{1}}} | 1 | 2 }}	Wenn der Name aus 2 Teilen besteht, wird der zweite Teil des Namens verwendet.
andernfalls		{{#titleparts: {{{1}}} | 2 | 3 }}	Wenn der Name aus 4 Teilen besteht, werden die beiden letzten Bestandteile verwendet. Wenn der Name aus 3 Teilen besteht, liefert diese Anweisung den dritten (also letzten) Bestandteil.

Siehe auch

• ParserFunctions – Erläuterungen zu Funktionen der Wiki-Software, hier vor allem zu #if und #titleparts

---

Eigene Navigation

Hier wird beschrieben, wie eine bucheigene Navigation in die automatische Navigation eingebunden wird.

Voraussetzungen

Die bucheigene Navigation muss einen Namen Buchname/ Vorlage:Navigation tragen (das Wort „Buchname“ ist natürlich durch den konkreten Namen zu ersetzen) und in die Kategorie:Bucheigene Vorlage eingetragen werden.

Verwendung

Eine bucheigene Navigation zu benutzen, wird für folgende Situationen angeboten:

• Dem Hauptautor eines Buches gefällt die Standardvorlage zur Navigation nicht.
• Wie auf vielen Hilfe-Seiten, beispielsweise Hilfe:Fertigstellen, soll anstelle der Links "zurück" und "weiter" eine größere Liste von Kapiteln als Verweis angeboten werden.
• Wie bei Multimedia im Überblick soll neben den Links "zurück" und "weiter" eine solche Liste von Kapiteln angeboten werden, und zwar in eine Navigationsleiste verpackt.

Parameter

Die Parameter erhalten von der Vorlage AutoNavigation Anzeige passende Werte. Sie können in der eigenen Navigation wahlweise benutzt oder ignoriert werden.

Sofern aus den Buchdaten oder Teildaten weitere Informationen geholt werden sollen, können auch diese und weitere Daten als Parameter berücksichtigt werden. Für solche Erweiterungen haben wir den Wunschzettel vorbereitet. Solche Abfragen können aber auch direkt in die eigene Navigation eingebaut werden.

Die vollständige Liste ist in der Dokumentation zu dieser Vorlage aufgeführt. Zu beachten ist, dass in allen Fällen ein Verweis fehlen kann. Für eine bucheigene Navigation werden die Links aufgeteilt in den eigentlichen Link und einen Anzeigetext.

Links in „Anzeige“	aufgeteilte Werte	Weitere Hinweise
regal, reihe		Verweise auf Regal und Reihe, sofern das in den Buchdaten eingetragen wird
buch	buchLink	Verweis auf das Inhaltsverzeichnis des Buches
	buchText	Text „Inhaltsverzeichnis“
hochLink, hochText		Werte werden direkt übergeben
start	startLink, startText	Verweis auf den Anfang des Buches oder Teils
ende	endeLink, endeText	Verweis auf das Ende des Buches oder Teils
zurück	zurückLink, zurückText	Verweis auf das vorige Kapitel oder den vorigen Teil
weiter	weiterLink, weiterText	Verweis auf das nächste Kapitel oder den nächsten Teil

Hinweis: Wenn ein Link auf zurück fehlt und start vorhanden ist, ersetzt der start-Verweis den Link auf das vorige Kapitel. Ebenso ersetzt der ende-Verweis einen fehlenden weiter-Link auf das nächste Kapitel.

---

Vorbereitung

Hier wird die Arbeitsweise der folgenden Vorlagen für Gesamtseiten genauer beschrieben:

• AutoGesamt
• AutoGesamt Start
• AutoGesamt Buch Teile
• AutoGesamt Teil Start
• AutoGesamt Teil Bereiche

Beachte auch die allgemeinen Hinweise zur Definition dieser Vorlagen, zu Parametern und zur Abfrage von Werten.

Verschiedene Parameter werden früher als nötig festgelegt und weitergegeben, um wiederholte Zuweisungen zu vermeiden.

Struktur

Die folgende Darstellung zeigt stark vereinfacht den Zusammenhang der Vorlagen für Gesamtseiten.

			AutoGesamt
			⇓
⌈			AutoGesamt Start
⇓			⇓	⇓
AutoGesamt Buch Teil	AutoGesamt Buch Teil	⇒	AutoGesamt Buch Teil	AutoGesamt Buch Teil	⇒	AutoGesamt Buch Teil	AutoGesamt Buch Teil
⇓			⇓	⇓
⇓			AutoGesamt Teil Start		⇒	AutoGesamt Teil Bereiche
⇓			⇓			⇓
AutoGesamt Buch			AutoGesamt Teil			AutoGesamt Bereich

Allgemeine Angaben

Einleitung und Zusammenfassung

Die Namen eines einleitenden und eines abschließenden Kapitels innerhalb des Buchs oder eines Teils werden immer mit der Zusatzvorlage GetStandard geholt. Überall dort, wo kapE, kapZ bestimmt wird, wird diese Vorlage mit den richtigen Parametern eingebunden.

Vorspann

Die folgenden Angaben werden durch mehrere Vorlagen, die hier erläutert werden, für die jeweils nächste Vorlage bereitgestellt.

Parameter	Kurzhinweis	Erläuterung
kapE	Einleitung	Name des einleitenden Kapitels für das Buch oder den Teil, soweit vorhanden
kapZ	Zusammenfassung	Name des abschließenden Kapitels für das Buch oder den Teil, soweit vorhanden
bild	Bildname	Name einer Datei, die am Anfang des Buches oder Teils den Inhalt illustrieren soll
gruppe	Zielgruppe	Hinweis am Anfang des Buches oder Teils
ziel	Lernziel	Erläuternde Texte am Anfang des Buches oder Teils
inhalt	Kurzinhalt
image	Bildgröße	allgemeine Angabe aus den Buchdaten für die Bilder

AutoGesamt

Die Vorlage AutoGesamt ist im Prinzip der einzige Inhalt der Seiten „Gesamtes Buch“ und „Gesamter Teil“. Sie wird normalerweise ohne Parameter aufgerufen und übergibt einige feste Werte zur weiteren Prüfung und Bearbeitung an die nächste Vorlage.

Außerdem gibt es eine Kontrollmaßnahme: Wenn ein Parameter übergeben wird, ist das ein Hinweis darauf, dass die Seite zu komplex ist und nicht dargestellt werden kann. In diesem Fall gibt die Vorlage AutoGesamt Fehler stattdessen eine Fehlermeldung; diese wird im nächsten Kapitel beschrieben.

Die Vorlage übergibt Parameter mit folgenden Prüfungen:
Parameter	Prüfung	Erläuterung
name1	1. Teil des Seitennamens	Name des Buchs
datenB	Buchdaten	Liste der Teile oder Kapitel des Buchs
link	Druckversion	Es ist also eine Seite Gesamtes Buch, der Buchname wird als Link übergeben.
	andernfalls	Es ist also ein Gesamter Teil, der Name des Teils wird als Link übergeben.

AutoGesamt Start

Die Vorlage AutoGesamt Start ist die erste Prüfung, von welcher Art die Gesamtseite ist und wie sie aufgebaut werden muss. Der dabei vergebene Wert var Variante als Unterscheidung wird wiederholt verwendet; die anderen Parameter werden bei der Verwendung durch die nächste Vorlage erläutert.

Variante	Prüfung	Situation	Fortsetzung	Dokumentation	übergebene Parameter
Druckversion, also eine Seite „Gesamtes Buch“
3	teile	Buch mit Teilen	Vorlage Buch Teile	nächster Abschnitt	datenB, name, var, max, image
1	andernfalls	Buch ohne Teile	Vorlage Buch	nächstes Kapitel	datenB, name, var, max, image; kapE, kapZ, bild, gruppe, ziel, inhalt
andernfalls keine Druckversion, also eine Seite „Gesamter Teil“
4	–	ein einzelner Teil	Vorlage Teil Start	übernächster Abschnitt	datenB, link, name, var

AutoGesamt Buch Teile

Die Vorlage AutoGesamt Buch Teile regelt die gesamte Darstellung eines Buches mit Teilen (Variante 3). Sie wird von der Vorlage AutoGesamt Start aufgerufen.

Die Vorlage erhält Parameter mit folgenden Inhalten:
Parameter	Kurzinhalt	Erläuterung
datenB	Buchdaten	Liste der Teile und allgemeinen Angaben des Buchs
name	Buchname	wird als Link für alle Bestandteile des Buchs verwendet
var	3	Standardwert (wird zz. nicht weiter benutzt, aber für spätere Prüfungen vorgemerkt)
max	Anzahl der Teile	nötig für die folgende Prüfung
Diese Informationen werden für die folgenden Maßnahmen benutzt:
Schritt	Maßnahme	Erläuterung
1.	Kopfzeile	Der Name des Buchs wird am Anfang angezeigt und hervorgehoben.
2.	einzelner Teil AutoGesamt Teil Start	Für jeden der Teile 1 bis 20 wird die nächste Vorlage AutoGesamt Teil Start aufgerufen. Parameter: datenB, name, link, var=5
3.	Nachspann	Einige formale Angaben folgen am Schluss mit der Vorlage AutoGesamt Nachspann, siehe das Kapitel Zusatzvorlagen.

AutoGesamt Teil Start

Die Vorlage AutoGesamt Teil Start regelt die Darstellung eines einzelnen Teils. Sie wird so aufgerufen:

• Variante 4: bei der Darstellung eines einzelnen Teils durch AutoGesamt Start für diesen einzelnen Teil
• Variante 5: bei der Gesamtdarstellung eines Buchs mit Teilen durch AutoGesamt Buch Teile für jeden einzelnen Teil

Die Vorlage erhält Parameter mit folgenden Inhalten:
Parameter	Kurzinhalt	Erläuterung
datenB	Buchdaten	Liste der Teile und allgemeinen Angaben des Buchs
name	Teilname	wird als Link für die Bestandteile des Teils und für die Teildaten verwendet
link	Buchname	wird als Link für die Bestandteile des Buchs verwendet
var	4	Kennung dafür, dass es sich um eine Seite „Gesamter Teil“ handelt
	5	Kennung dafür, dass es sich um einen Teil der Seite „Gesamtes Buch“ handelt
Diese Informationen werden für die folgenden Maßnahmen benutzt:
Schritt	Prüfung	Fortsetzung	Dokumentation	Erläuterung
1.	Teildaten	AutoGesamt Teil Fehler	nächstes Kapitel	Wenn die Teildaten (noch) nicht vorhanden sind, gibt es eine Fehlermeldung.
2.	max bestimmen	AutoGesamt Teil Fehler	nächstes Kapitel	Wenn der max-Wert fehlt, sind die Bestandteile unbekannt, also gibt es eine Fehlermeldung.
3.	Teil mit Bereichen	AutoGesamt Teil Bereiche	nächster Abschnitt	Darstellung des Teils kann genauer vorbereitet werden.
	Teil ohne Bereiche	AutoGesamt Teil	nächstes Kapitel	Darstellung des Teils kann sofort erledigt werden.
	in beiden Fällen identische Parameter: datenT, name, link, var, max kapE, kapZ, bild, gruppe, ziel, inhalt, image als allgemeine Angaben des Teils Hier werden die Vorlagen „trickreich“ benutzt: Der Name der Vorlage wird durch #if bestimmt; dazu kommen die Parameter; alles zusammen wird als Vorlagenaufruf benutzt.

AutoGesamt Teil Bereiche

Die Vorlage AutoGesamt Teil Bereiche regelt die Darstellung eines einzelnen Teils mit Bereichen. Sie wird von der Vorlage AutoGesamt Teil Start aufgerufen.

Die Vorlage erhält Parameter mit diesen Inhalten: kapE, kapZ, bild, gruppe, ziel, inhalt, image als allgemeine Angaben des Teils dazu die folgenden speziellen Angaben
Parameter	Kurzinhalt	Erläuterung
datenT	Teildaten	Liste der Bereiche, Kapitel und allgemeinen Angaben des Teils
name	Teilname	wird zur Gliederung des Teils verwendet
link	Buch/ Teil	wird als Link für die Bestandteile des Teils verwendet
var	4	Kennung dafür, dass es sich um eine Seite „Gesamter Teil“ handelt
	5	Kennung dafür, dass es sich um einen Teil der Seite „Gesamtes Buch“ handelt
Diese Informationen werden für die folgenden Maßnahmen benutzt:
Schritt	Maßnahme	Erläuterung
1.	Kopfzeile	Der Name des Teils wird am Anfang angezeigt und hervorgehoben. Bei var=4 gibt es einen ergänzenden Hinweis.
2.	Vorspann AutoVorlagen Vorspann	Wenn eine der Angaben bild, gruppe, ziel, inhalt vorgesehen ist, wird der Vorspann dargestellt. Parameter: alle diese Angaben – Dokumentation im letzten Kapitel des Teils
3.	Einleitung AutoGesamt Kapitel	Wenn ein einleitendes Kapitel vorgesehen ist, wird es dargestellt. Parameter: link, name – Dokumentation im nächsten Kapitel
4.	einzelner Bereich AutoGesamt Bereich	Für jeden der Bereiche 1 bis 20 wird die nächste Vorlage AutoGesamt Bereich aufgerufen. Parameter: datenT, name, link, nr, max – Dokumentation im nächsten Kapitel
5.	Zusammenfassung AutoGesamt Kapitel	Wenn ein abschließendes Kapitel vorgesehen ist, wird es dargestellt. Parameter: link, name – Dokumentation im nächsten Kapitel
6.	Nachspann AutoGesamt Nachspann	Bei var=4 folgen am Schluss einige formale Angaben. – Dokumentation im nächsten Kapitel

---

Darstellung

Hier wird die Arbeitsweise der folgenden Vorlagen für Gesamtseiten genauer beschrieben:

• AutoGesamt Kapitel
• Gesamtdarstellung für AutoGesamt Buch – AutoGesamt Teil – AutoGesamt Bereich
• AutoGesamt Nachspann
• AutoGesamt Fehler
• AutoGesamt Teil Fehler

Beachte auch die allgemeinen Hinweise zur Definition dieser Vorlagen, zu Parametern und zur Abfrage von Werten.

AutoGesamt Kapitel

Die Vorlage AutoGesamt Kapitel wird aufgerufen durch die drei folgenden Vorlagen (Buch, Teil, Bereich) und bindet jeweils ein Kapitel in diese Darstellungen ein.

Die Vorlage erhält die folgenden Informationen:
Nr.	Parameter	Kurzhinweis	Erläuterung
	name	Kapitelname	der eigentliche Name des Kapitels
	link	Seitenname	der Name des Buchs, des Teils oder des Bereichs, zu dem das Kapitel gehört
Mit diesen Informationen gibt es die folgenden Maßnahmen.
Schritt	Maßnahme	Kurzhinweis	Erläuterung
1.	Titelzeile	Angabe des Kapitels	Überschrift der 1. Ebene und Link zur Bearbeitung dieses Kapitels; dazu wird die spezielle Vorlage:H1 verwendet
2.	Prüfung	Existenz des Kapitels	Auch Kapitel, die es noch nicht gibt, können berücksichtigt werden.
		Kapitel vorhanden	Das Kapitel wird vollständig als Unterseite in die Gesamtseite eingebunden.
		Kapitel fehlt	Es gibt einen entsprechenden Hinweis.

Gesamtdarstellung

AutoGesamt Buch

Die Vorlage AutoGesamt Buch wird aufgerufen durch die Vorlage AutoGesamt Start und stellt alle Kapitel eines Buches ohne Teile (Variante 1) dar.

AutoGesamt Teil

Die Vorlage AutoGesamt Teil wird aufgerufen durch die Vorlage AutoGesamt Teil Start und stellt alle Kapitel eines Teils ohne Bereiche (Variante 4 oder 5) dar.

AutoGesamt Bereich

Die Vorlage AutoGesamt Bereich wird aufgerufen durch die Vorlage AutoGesamt Teil Bereiche und stellt alle Kapitel eines Bereichs (Varianten 4/5) dar.

Einheitliches Verfahren

Sowohl die Parameter als auch die Maßnahmen sind sich in allen Varianten sehr ähnlich und werden deshalb gemeinsam beschrieben.

Jede der Vorlagen erhält diese Informationen:
Parameter	Variante	Kurzhinweis	Erläuterung
datenB	Buch	Buchdaten	Liste der Kapitel des Buchs
datenT	Teil, Bereich	Teildaten	Liste der Kapitel des Teils oder Bereichs
name	einheitlich	Name	der eigentliche Name zur Variante (Buch, Teil, Bereich); beim Buch auch als Link für alle zugehörigen Kapitel verwendet
link	Teil, Bereich	Buch/ Teil	der Seitenname des Teils als Grundlage für die eingebundenen Kapitel
max	einheitlich	Maximum	Anzahl der Kapitel des Buchs, Teils oder Bereichs
var	Teil	4 oder 5	Dieser Wert wird nur beim Teil für eine Prüfung benötigt.
allgemein	Buch, Teil	Angaben	die Parameter kapE, kapZ, bild, gruppe, ziel, inhalt, image als allgemeine Angaben zum Buch oder Teil
Mit diesen Informationen gibt es die folgenden Maßnahmen.
Schritt	Variante	Maßnahme	Erläuterung
1.	einheitlich	Überschrift	Der Name des Buchs, Teils oder Bereichs wird am Anfang angezeigt und hervorgehoben.
2.	Buch, Teil var=4	Hinweistext	zusätzlicher Hinweis auf den Inhalt der Gesamtseite (entfällt bei einem Teil, der zur Gesamtseite des Buchs gehört)
3.	Buch, Teil	Vorspann	Wenn eine der Angaben bild, gruppe, ziel, inhalt vorgesehen ist, wird der Vorspann dargestellt. Aufruf der ergänzenden Vorlage Vorspann – Parameter: alle diese Angaben – Dokumentation im letzten Kapitel des Teils
4.	Bereich	Kapitel vorhanden	Prüfung durch max, ob Kapitel registriert sind; ggf. nur Fehlermeldung (Für Buch oder Teil findet diese Prüfung in einer der Vorlagen zur Vorbereitung statt; für Bereich wäre diese Prüfung der einzige Grund für eine zusätzliche Vorlage.)
5.	Buch, Teil	Einleitung	Wenn ein einleitendes Kapitel vorgesehen ist, wird es dargestellt durch die Vorlage AutoGesamt Kapitel – siehe oben.
6.	einheitlich	einzelnes Kapitel	Jedes der Kapitel 1 bis 20 wird zur Darstellung eingebunden durch die Vorlage AutoGesamt Kapitel – siehe oben.
7.	Buch, Teil	Zusammenfassung	Wenn ein abschließendes Kapitel vorgesehen ist, wird es dargestellt durch die Vorlage AutoGesamt Kapitel – siehe oben.
8.	Buch, Teil var=4	Nachspann	Am Schluss folgen einige formale Angaben durch die Vorlage AutoGesamt Nachspann – siehe den nächsten Abschnitt.

AutoGesamt Nachspann

Die Vorlage AutoGesamt Nachspann wird einmalig am Ende einer Gesamtseite aufgerufen und liefert ergänzende Hinweise zur Verwendung über Wikibooks.

• Vorlage:Druckversionsnotiz – Dazu werden folgende Parameter übergeben: der Name des Buches oder der Seite, die Anzahl der Druckseiten und des Datums (Informationen aus den Buchdaten oder den Teildaten).
• eine Liste der Autoren (das ist zz. nicht automatisch möglich)
• Vorlage:Doppellizenz CC-by-sa GFDL

AutoGesamt Fehler

Die Vorlage AutoGesamt Fehler wird aufgerufen durch die Vorlage AutoGesamt, wenn die Gesamtseite zu komplex ist und deshalb nicht dargestellt werden kann. Parameter werden nicht benötigt; die Vorlage erkennt anhand des Seitennamens, für welche Seite der Fehler angezeigt werden soll.

AutoGesamt Teil Fehler

Die Vorlage AutoGesamt Teil Fehler wird aufgerufen durch die Vorlage AutoGesamt Teil Start und beschränkt sich auf einen Fehlerhinweis, wenn die Teildaten noch nicht existieren oder unvollständig sind.

Als Parameter werden übergeben der Name des Teils und die Variante. Damit werden eine Überschrift und geeignete Hinweise erstellt.

---

Ergänzende Vorlagen

In diesem Kapitel werden Vorlagen beschrieben, die an mehreren Stellen verwendet werden, um Informationen zu bestimmen oder anzuzeigen.

AutoVorlagen GetNumber

Die Vorlage AutoVorlagen GetNumber sucht die Position eines Eintrags in einer Datenseite: Teil im Buch, Bereich im Teil und Kapitel im Buch, Teil oder Bereich. Weil die Einträge in den Buchdaten und den Teildaten einfach durchnummeriert sind, kann die Vorlage für alle Aufgaben verwendet werden. Sie wird aufgerufen durch die Vorlagen AutoNavigation Start und AutoNavigation Ebene3 Start – beschrieben im Kapitel AutoNavigation/ Vorbereitung.

Dieser Vorlage werden die folgenden Informationen übergeben. Der Hinweis auf Ebene 2, 3, 4 bedeutet, dass der 2., 3. oder 4. Bestandteil des Namens in der Liste gesucht wird.
Name	Ebene	Hinweis	Bedeutung
name	2		der 2. Bestandteil als Name eines Kapitels oder Teils im Buch
	3		der 3. Bestandteil als Name eines Kapitels oder Bereichs im Teil
	4		der 4. Bestandteil als Name eines Kapitels im Bereich
daten	2	Buchdaten	die Liste der Kapitel oder Teile des Buchs
	3, 4	Teildaten	die Liste der Kapitel oder Bereiche im Teil
teil	2, 3	(leer)	keine Angabe, es wird die eigentliche Nummer gesucht
	4	2/	Nummer des Bereichs, in dem gesucht wird
max	2, 3, 4		Anzahl der Einträge, in denen gesucht wird (Buch, Teil, Bereich)
kapE, kapZ	2		Namen des einleitenden und abschließenden Kapitels im Buch
	3		Namen des einleitenden und abschließenden Kapitels im Teil
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt. Dazu wird der gesuchte Wert name nacheinander (verschachtelt) durch #ifeq mit weiteren Angaben verglichen:
Bedingung		Rückgabewert	Erläuterung
wenn name gleich kapE dann		0	name ist das einleitende Kapitel, es kommt vor dem ersten Kapitel
wenn name gleich kapZ dann		max + 1	name ist das abschließende Kapitel, es kommt nach dem letzten Kapitel
Für die weiteren Vergleiche wird jeweils der Name des nächsten Eintrags in daten bestimmt.
wenn name gleich <Eintrag 1> dann		1	name ist gleich dem ersten Eintrag
wenn name gleich <Eintrag 2> dann		2	name ist gleich dem zweiten Eintrag
Diese Prüfung wird bis zu 20 Mal wiederholt.

AutoVorlagen GetStandard

Die Vorlage AutoVorlagen GetStandard bestimmt den tatsächlichen Namen des einleitenden oder abschließenden Kapitels in einem Buch oder Teil. Dies ist sinnvoll und notwendig, weil nicht nur die Standardbezeichnungen Einleitung und Zusammenfassung möglich sind, sondern auch beliebige andere Namen wie in diesem Teil Dokumentation.

Die Vorlage wird an folgenden Stellen aufgerufen:

• AutoInhalt Start und AutoInhalt Ebene2 Start – beschrieben im Kapitel AutoInhalt/ Vorbereitung
• AutoNavigation und AutoNavigation Vorbereitung und AutoNavigation Ebene3 Start – beschrieben im Kapitel AutoNavigation/ Vorbereitung
• AutoGesamt Start und AutoGesamt Teil Start – beschrieben im Kapitel AutoGesamt/ Vorbereitung

Dieser Vorlage werden die folgenden Informationen übergeben:
Nr.	Name	Beispiel	Bedeutung
1	daten	Buchdaten	suche ein Kapitel für das Buch
		Teildaten	suche ein Kapitel für den Teil
2	var	E	suche das einleitende Kapitel
		Z	suche das abschließende Kapitel
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt.
Schritt	Maßnahme		Erläuterung
1.	hole den Wert		bestimme die Angabe, die in den daten bei E bzw. Z eingetragen ist
2.	Wert gleich ja		wenn der Wert gleich ja ist, ist der Standardname zu verwenden
2.1	E gesucht		in diesem Fall ist der Standardname Einleitung zu verwenden
2.2	Z gesucht		andernfalls ist der Standardname Zusammenfassung zu verwenden
3.	Wert ungleich ja		dann ist der eingetragene Wert als Name zu übernehmen

AutoVorlagen Vorspann

Die Vorlage AutoVorlagen Vorspann zeigt die allgemeinen Angaben für ein Buch oder einen Teil an, und zwar in gleicher Weise für das Inhaltsverzeichnis und die Gesamtanzeige des Buchs oder eines Teils. Sie wird aufgerufen durch die folgenden Vorlagen:

• AutoInhalt Ebene1 und AutoInhalt Ebene2 – beschrieben im Kapitel AutoInhalt/ Anzeige
• AutoGesamt Start und AutoGesamt Teil Start – beschrieben im Kapitel AutoGesamt/ Vorbereitung

Dieser Vorlage werden die folgenden Informationen übergeben:
Nr.	Name	Beispiel	Bedeutung
1	bild	Zeichen 206.svg	Name einer Bilddatei, soweit gewünscht
2	gruppe	Alle Leser	Angabe der Zielgruppe für Buch oder Teil, sofern vorgesehen
3	ziel	Allgemeines Verständnis	Angabe des Lernziels, sofern vorgesehen
4	inhalt	Ein kurzer Text	Kurzinhalt, sofern vorgesehen
	image	240px	Größe für ein Bild (eine Datei) innerhalb des Inhaltsverzeichnisses
Mit diesen Angaben werden die folgenden Prüfungen und Maßnahmen ausgeführt. Sofern der 1. Parameter bild einen Wert liefert, wird dieses Bild dargestellt; als Größe wird die Angabe image benutzt. Sofern der 2. Parameter gruppe einen Wert liefert, wird die Zielgruppe angegeben. Sofern der 3. Parameter ziel einen Wert liefert, wird das Lernziel angezeigt. Sofern der 4. Parameter inhalt einen Wert liefert, wird ergänzend der Kurzinhalt angezeigt.

---

• Autorenliste, sofern möglich