Zum Inhalt springen

Wikibooks Automatische Vorlagen/ Verwendung/ Allgemeine Hinweise

Links hinzufügen
Aus Wikibooks
 Regal:Anleitungen Inhaltsverzeichnis  Inhaltsverzeichnis Allgemeine Hinweise  Allgemeine Hinweise Inhalt „Verwendung“ Inhalt „Verwendung“ Buch ohne Teile  Buch ohne Teile Probleme und Lösungen  Probleme und Lösungen

Die folgenden Hinweise sind für die Funktionsfähigkeit der automatischen Vorlagen unbedingt zu beachten.

Einfache Verwendung

[Bearbeiten]

Die automatischen Vorlagen sind äußerst nützlich bei Büchern mit mehreren Kapiteln. Das gilt erst recht dann, wenn das Buch mehrere Teile enthält (wie Lehrbücher für Sprachen oder Programmiersprachen) und jeder Teil selbst aus mehreren Kapiteln besteht oder noch in Bereiche gegliedert ist.

Die Vorlagen werden wie folgt eingebunden:

{{AutoInhalt}} kommt einmalig auf die Hauptseite des Buches (Startseite oder separates Inhaltsverzeichnis).
{{AutoNavigation}} gehört unbedingt in jedes einzelne Kapitel.
{{AutoGesamt}} gehört auf alle Seiten, die ein Buch oder einen Teil als Ganzes darstellen sollen.

Das genügt – mehr Angaben sind nicht erforderlich. Vorschläge für weitere Inhalte stehen bei den Kopiervorlagen.

Voraussetzungen

[Bearbeiten]

Damit die Vorlagen wie gewünscht arbeiten, muss das Buch so konstruiert sein:

  • Als Trennzeichen zwischen dem Namen des Buches und den Kapitelnamen muss der Schrägstrich verwendet werden. Der Name des Buches selbst darf keinen Schrägstrich enthalten.
  • Die Namen der Kapitel werden in zwei bis vier Ebenen zusammengesetzt, wie auf der aktuellen Seite durch Wikibooks Automatische Vorlagen/ Verwendung/ Allgemeine Hinweise:
    1. der Name des Buches selbst, hier: Wikibooks Automatische Vorlagen
    2. der Name des einzelnen Teils, hier: Verwendung
    3. der Name eines Bereichs – das wird in diesem Teil nicht verwendet, aber im Teil Dokumentation
    4. der Name des Kapitels, hier: Allgemeine Hinweise
  • Bei Bedarf kann von dieser Regel abgewichen werden.
    • Man kann sich auf zwei Ebenen (Buch und Kapitel) beschränken.
    • Ein einzelner Teil kann auch aus einem einzigen Kapitel bestehen wie in diesem „Buch“ die Einführung.
    • Ein einzelner Teil kann Kapitel oder Bereiche enthalten.
  • Ein Anhang ist wie ein Teil zu behandeln und enthält ebenfalls mehrere Kapitel (oder auch ein einziges).

Bezeichnungen

[Bearbeiten]

Für die Gliederung werden folgende Begriffe verwendet:

Für eine weitere Untergliederung sind die automatischen Vorlagen nicht geeignet.

Daten-Seiten

[Bearbeiten]

Die Gliederung des Buches wird in speziellen Seiten gespeichert, die mit der Wiki-Syntax zur Vorlagen-Programmierung arbeiten und als bucheigene Vorlagen gespeichert werden.

  • In einer Seite Buch/ Vorlage:Daten stehen die Teile oder Kapitel des Buches selbst sowie ein paar allgemeine Festlegungen.
    Buchdaten ist die Abkürzung dafür in diesem „Buch“.
  • In den Seiten Buch/ Vorlage:Daten Teil stehen die Kapitel und Bereiche zu jeweils einem Teil des Buches.
    Teildaten ist die Abkürzung dafür in diesem „Buch“.

Die automatischen Vorlagen sorgen dafür, dass diese Datenseiten richtig analysiert und umgesetzt werden. Außerdem helfen Preload-Vorlagen beim richtigen Aufbau der Datenseiten.

Zum besseren Verständnis der Erläuterungen bietet es sich an, diese Beschreibung und den Quelltext einer Datenseite in zwei Fenstern des Browsers zu öffnen und nebeneinander zu lesen.

Die Grundstruktur

[Bearbeiten]

Jede Datenseite enthält die folgenden Zeilen: 

<includeonly>{{#switch: {{{1}}}
| max = 4
}}</includeonly><noinclude>{{AutoVorlagen Dokumentation}}</noinclude>
includeonly

Durch <includeonly>...</includeonly> wird der eigentliche Inhalt eingerahmt. Das vereinfacht die Verarbeitung durch die Wiki-Software.

noinclude

Die letzte Zeile <noinclude>{{...}}</noinclude> verweist auf eine einheitliche Dokumentation all dieser Vorlagen und Datenseiten und sorgt für die richtige Kategorie der bucheigenen Vorlagen.

switch

Die switch-Anweisung ist der wichtigste Bestandteil; sie stellt die jeweils benötigte Information bereit. Die Anweisung selbst beginnt mit den geschweiften Klammern {{# und dem Rest der ersten Zeile und endet mit den geschweiften Klammern }} am Anfang der letzten Zeile.

Einzelangaben

Dazwischen stehen in jeweils einer Zeile die einzelnen Angaben: Die Zeile beginnt immer mit dem Pipe-Zeichen |. Dann folgen der Name der Angabe, das Gleichheitszeichen und der konkrete Wert. Beim Namen sind Groß- und Kleinbuchstaben zu beachten. Leerzeichen dazwischen können stehen oder entfallen.

Maximum

Die Angabe max teilt den Vorlagen die Anzahl der Einträge mit: Kapitel oder Teile eines Buches, Kapitel oder Bereiche eines Teils. Diese Information darf niemals fehlen.

Weitere Angaben hängen von der Gliederung des Buches ab und werden in den folgenden Kapiteln erläutert.

Siehe auch

[Bearbeiten]
 Regal:Anleitungen Inhaltsverzeichnis  Inhaltsverzeichnis Allgemeine Hinweise  Allgemeine Hinweise Inhalt „Verwendung“ Inhalt „Verwendung“ Buch ohne Teile  Buch ohne Teile Probleme und Lösungen  Probleme und Lösungen
Abgerufen von „https://de.wikibooks.org/w/index.php?title=Wikibooks_Automatische_Vorlagen/_Verwendung/_Allgemeine_Hinweise&oldid=713348“