Wikibooks Automatische Vorlagen/ Dokumentation/ AutoNavigation/ Anzeige

Regal:Anleitungen

Inhaltsverzeichnis

Inhalt „Dokumentation“

Allgemeine Hinweise

AutoNavigation/ Vorbereitung

AutoNavigation/ Zusatzvorlagen

Ergänzende Vorlagen

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

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
daten	3, 4	`datenT`	Datenseite des Teils
link	1, 2	`name1`	Seitenname des Buchs
link	3, 4	`name1/ name2`	Seitenname des Teils
name1	immer	Buchname	erster Bestandteil des Seitennamens
name2	1	Kapitel	zweiter Bestandteil des Seitennamens
name2	2, 3, 4	Name des Teils	zweiter Bestandteil des Seitennamens
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
hochLink, hochText	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
zurück	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
weiter	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.

Name	Kurzhinweis	Bedeutung
Neben den einheitlichen Angaben werden die folgenden Parameter übergeben.
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.

Name	Kurzhinweis	Bedeutung
Neben den einheitlichen Angaben werden die folgenden Parameter übergeben.
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)`.
zurück	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)`.
weiter	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
hochLink, hochText	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