Wikibooks Automatische Vorlagen/ Dokumentation/ AutoInhalt/ 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:
Beachte auch die allgemeinen Hinweise zur Definition der Vorlagen, zu Parametern und zur Abfrage von Werten.
Allgemeine Angaben
[Bearbeiten]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 |
|
AutoInhalt Ebene1
[Bearbeiten]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 |
| ||
Anzeige eines Rahmens um das Inhaltsverzeichnis mit einer Überschrift (nicht bei der LaTeX-Seite) | ||
| ||
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. |
| ||
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
[Bearbeiten]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 | |
| |||
Anzeige des Kopfes für den Teil (bei der LaTeX-Seite stark verkürzt)
| |||
| |||
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. | |
| |||
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. | |
| |||
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)
|
AutoInhalt Ebene3
[Bearbeiten]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 | AutoInhalt | 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 | |||
| |||
Ja | Inhaltsangabe | In diesem Fall wird ein Kurzinhalt angezeigt. | |
| |||
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
[Bearbeiten]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.
|
AutoInhalt Zeile
[Bearbeiten]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 | Anzeige | 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.
|
AutoVorlagen Vorspann
[Bearbeiten]Diese Vorlage wird an mehreren Stellen benötigt; sie wird im letzten Kapitel Ergänzende Vorlagen der Dokumentation beschrieben.