Wikibooks Automatische Vorlagen/ Dokumentation/ AutoGesamt/ Vorbereitung
Hier wird die Arbeitsweise der folgenden Vorlagen für Gesamtseiten genauer beschrieben:
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
[Bearbeiten]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
[Bearbeiten]- 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
[Bearbeiten]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
[Bearbeiten]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
[Bearbeiten]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
[Bearbeiten]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:
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
[Bearbeiten]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:
| ||
| 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 |