Hauptmenü öffnen

Wikibooks Automatische Vorlagen/ Dokumentation/ AutoGesamt/ Darstellung

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.

AutoGesamt KapitelBearbeiten

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.

GesamtdarstellungBearbeiten

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 NachspannBearbeiten

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 FehlerBearbeiten

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 FehlerBearbeiten

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.