Zum Inhalt springen

Wikibooks Automatische Vorlagen/ Verwendung/ Buch mit Teilen

Aus Wikibooks

In diesem Kapitel wird erläutert, wie ein (neues) Buch aufgebaut wird, damit die Vorteile der automatischen Vorlagen wirken können.

Als Beispiel dient dieses „Buch“.

Schritt für Schritt

[Bearbeiten]

Beim Anfang eines neuen Buches, das in Teile gegliedert werden soll, ist wie folgt vorzugehen:

  1. Beachte die allgemeinen Hinweise im einleitenden Kapitel, vor allem die Voraussetzungen.
  2. Trage auf der Seite, die das Inhaltsverzeichnis anzeigen soll, den Quelltext ein, der am Anfang des Abschnitts Die Anzeige des Inhalts steht; dort sind auch weitere mögliche Inhalte erwähnt. Speichere diese Seite.
  3. Klicke auf den vorbereiteten Link zur Seite Buchdaten und trage dort die gewünschten Teile des Buches sowie ein paar allgemeine Angaben ein.
  4. Speichere diese Seite und lade erneut die Seite mit dem Inhaltsverzeichnis.
  5. Klicke nun nacheinander in jedem Teil auf die Links zu den Teildaten, wie in den beiden nächsten Kapiteln beschrieben, und trage dort die gewünschten Kapitel sowie ergänzende Angaben ein.
  6. Speichere alle diese Seiten und lade abschließend die Seite mit dem Inhaltsverzeichnis neu.

Danach kann (mit Klicks auf die einzelnen Kapitel) das Schreiben des Buches beginnen.

Die Anzeige des Inhalts

[Bearbeiten]

Die Seite mit dem Inhaltsverzeichnis enthält in erster Linie den folgenden Inhalt:

{{TOCright}} {{AutoInhalt}}

Zur automatischen Erstellung des Inhaltsverzeichnisses sind keine weiteren Angaben erforderlich. Dies hat die folgenden Auswirkungen.

{{TOCright}}
Damit werden die Namen der Teile und Bereiche als Wiki-eigenes Inhaltsverzeichnis in einem Kasten rechts oben angezeigt.
Alternativ sind – je nach Wunsch – auch __TOC__ (am Anfang des Textes) oder __NOTOC__ (Verzicht auf das Wiki-Inhaltsverzeichnis) möglich.
{{AutoInhalt}}
Diese Vorlage holt sich aus der Seite Buchdaten die Liste der Teile und aus den Teildaten die Listen der Kapitel und erzeugt daraus selbständig das Inhaltsverzeichnis.

Die Autoren sind frei darin, wie andere Teile der Startseite eingefügt werden:

Automatisch stehen unter dem Inhaltsverzeichnis folgende Links:

  • Gesamtes Buch auf eine Seite, die alle Kapitel des Buchs am Stück anzeigt
  • Buchdaten auf die Datenseite
  • LaTeX-/PDF-Export auf eine spezielle Seite, die vor allem dem Export mit wb2pdf dient

Die Datenseiten

[Bearbeiten]

Ein Buch mit Teilen enthält mehrere Datenseiten:

  • Die Buchdaten enthalten die Liste der Teile und die allgemeinen Angaben zum Buch.
  • Die Teildaten enthalten die Listen von Kapiteln und ggf. Bereichen und zusätzliche Informationen zu den Teilen.

Zunächst müssen die Buchdaten erstellt werden. Als Beispiel dient natürlich dieses „Buch“, also die Seite Wikibooks Automatische Vorlagen/ Vorlage:Daten.

Allgemeine Angaben

[Bearbeiten]

Die folgenden Angaben stehen am Anfang der Buchdaten.

| inhalt = {{#titleparts:{{subst:PAGENAME}}|1|1}}
| Bildgröße = 240px
| regal = Anleitungen
| reihe =
| DruckTOC = rechts
| navi2zeilig = ja
| teile = ja

Sie haben folgende Bedeutungen:

inhalt (Pflicht)
Hierher gehört die Seite, auf der das Inhaltsverzeichnis steht; die Schreibweise ist unwichtig. Diese Seite wird wegen der Links in der automatischen Navigation benötigt.
regal, reihe, Bildgröße (Option)
  • Wenn in der automatischen Navigation auf jeder Seite das Regal angegeben werden soll, wird es hier eingetragen.
  • Wenn das Buch Teil einer Reihe ist, ist in der Navigation ebenfalls ein Hinweis möglich.
  • Wenn der Anfang eines Teils mit einem Bild versehen wird, holen sich die Vorlagen von hier die gewünschte Größe.
DruckTOC (Option)
Dies sollte das Inhaltsverzeichnis auf den Gesamtseiten regeln, hat aber zurzeit keine Bedeutung. Die Zeile kann also wahlweise belassen oder gestrichen werden.
navi2zeilig (Option)
Wenn ein Teil in Bereiche untergliedert wird, benötigt die Navigation zwischen den Kapiteln unter Umständen zuviel Platz. Dann wird mit dieser Option eine zweizeilige Navigation erreicht. Bitte vergleiche die Navigation in diesem Kapitel mit derjenigen im Teil „Dokumentation“.

Die einzelnen Teile

[Bearbeiten]

Mit den folgenden Werten werden die Teile in den Buchdaten eingetragen.

| max = 4
| 1 = Einführung
| 2 = Verwendung
| 3 = Dokumentation
| 4 = Anhang

Einleitung und Zusammenfassung für das gesamte Buch sind nicht vorgesehen. Solche Kapitel passen bei Bedarf in den ersten und letzten Teil des Buches.

teile (Pflicht)
Mit teile = ja wird festgelegt, dass das Buch in drei oder vier Ebenen untergliedert wird, also mehrere Kapitel in Teile zusammengefasst werden.
max (Pflicht)
Dies gibt die Anzahl der vorgesehenen Teile an und wird für Prüfungen sowie für die automatische Navigation benötigt.
Die einzelnen Teile

Für jeden Teil ist die folgende Angabe vorgesehen.

  • Name (Pflicht): Der Wert für die Nummer bezeichnet den Namen des Teils.

Für das Buch sind maximal 20 Teile möglich.

Weitere Informationen über die allgemeinen Angaben und die Inhalte eines Teils folgen in den beiden nächsten Kapiteln Teil ohne Bereiche und Teil mit Bereichen.

Nachträgliche Änderungen

[Bearbeiten]

Dafür ist auf den Link zu den Buchdaten zu klicken (vorzugsweise mit Rechtsklick in einem neuen Tab des Browsers). Nach dem Speichern muss das Inhaltsverzeichnis neu geladen werden.

  • Zusätzliche Informationen (Inhaltsangaben u. ä.) können jederzeit problemlos geändert werden und werden sofort wirksam.
  • Die Reihenfolge der Teile und Kapitel kann ebenso geändert werden. Es muss nur ganz genau auf die Nummern in den Datenseiten geachtet werden.
  • Wenn das Buch anders gegliedert werden soll oder Teile und Kapitel umbenannt werden sollen, müssen Seiten umbenannt (also verschoben) werden.

All das wird im Kapitel Nachträgliche Änderungen genauer beschrieben.