Hauptmenü öffnen

Wikibooks Automatische Vorlagen/ Dokumentation/ Ergänzende Vorlagen

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

AutoVorlagen GetNumberBearbeiten

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 GetStandardBearbeiten

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:

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 VorspannBearbeiten

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:

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.