Hilfe:Vorlagen

Aus Wikibooks
Wechseln zu: Navigation, Suche

Hoch zum Lehrbuch

Vorlagen: FindenVerwendenBenennenErstellenErklären


Wikibooks hat das Lehrbuch:

Eine Vorlage ist eine Seite, die sich als Textbaustein verwenden lässt, d. h. als vorgefertigter Text, der in einen anderen Text eingefügt wird. Der Text und das Erscheinungsbild müssen nicht starr sein, denn eine Vorlage kann Inhalt und Erscheinungsbild durch Variablen beeinflussen.

Verwendungszweck[Bearbeiten]

Vorlagen dienen in Wikibooks zur:

  • Konsistenzmaximierung: Mit Vorlagen lässt sich ein einheitliches Erscheinungsbild erreichen. Beispiel: die Navigation zwischen den Kapiteln eines Buches .
  • Redundanzminimierung: Wenn der Inhalt zentral nur an einer Stelle festgelegt wird (d. h. in einer Vorlage), dann erscheint der Inhalt in allen Kapiteln gleich, auch bei einer nachträglichen Änderung. Das mühselige und fehlerträchtige Übertragen einer Änderung in jedes Kapitel entfällt. Beispiel: Medizin-Hinweis
  • Workflowoptimierung: Mit einer Vorlage kann ein Wikiautor prägnant anderen Wikiautoren mitteilen, in welche Richtung ein Kapitel verbessert werden sollte. Beispiele: Vorlage:Übersetzen oder Vorlage:Löschen
  • Codeoptimierung: Manche schöne Darstellung lässt sich nur mit einem unschönen Mix aus Wikibefehlen und HTML- bzw. CSS-Befehlen erreichen. Der Kapitelquellcode wird dann schnell unübersichtlich und verschreckt Wikianfänger sich auch an der weiteren Verbesserung eines Kapitels zu beteiligen. Hier kann eine Vorlage helfen, den Kapitelquellcode lesbarer zu gestalten. Beispiel: Vorlage:Formel

Bereiche von Vorlagen[Bearbeiten]

Diese Grundsätze dürfen bei uns nicht so weit getrieben werden, dass alle Bücher dasselbe Erscheinungsbild haben müssen. Um einerseits eine flexible, inhaltsgerechte Entwicklung zu gewährleisten und andererseits die Übersichtlichkeit zu wahren, gibt es in Wikibooks im Wesentlichen drei Arten von Vorlagen:

  • Projektweite Vorlagen sind solche, die für alle Bücher und Wikibooks insgesamt nützlich sind. Der Name beginnt mit Vorlage:, sie gehören also zum Namensraum Vorlage. Sie sind zu finden über die Unterkategorien der Kategorie:Vorlage.
  • Regalweite Vorlagen sind solche, die für Bücher eines bestimmten Regals nützlich sein können. Der Name beginnt grundsätzlich mit Regal:Name des Regals/ Vorlage:, sie gehören also zum Namensraum Regal. Sie sind zu finden über Kategorie:Regaleigene Vorlage.
  • Bucheigene Vorlagen gehören zu einem bestimmten Buch. Der Name beginnt grundsätzlich mit dem Namen des Buchs, gefolgt von einem Trennzeichen und dem Wort "Vorlage"; sie gehören also zum Hauptnamensraum (den Büchern). Sie sind zu finden über Kategorie:Bucheigene Vorlage und sollten auf einer Seite des Buches (z. B. bei der Projektdefinition) aufgeführt werden.

Mehr dazu siehe Vorlagen finden und Vorlagen benennen.

Vorlagen praktisch verwenden[Bearbeiten]

Um eine einfache Vorlage in einem Kapitel zu verwenden, gibt es vor allem diese Möglichkeit:

{{Name der Vorlage}}

Im Hauptanwendungsfall fügst du eine Vorlage mit {{Name der Vorlage}} (also mit geschweiften Klammern) in den Text des Kapitels ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung.

Beispiel: {{Grafiken geben Fortschritt an}} erzeugt folgende Anzeige:

Hinweis: Die kleinen Grafiken (100%) zeigen an, wie weit ein Buchprojekt bereits gediehen ist.

.

Oft sollen in einer Vorlage noch Inhalte auftauchen, die sich von Seite zu Seite ändern, zum Beispiel ein Link mitsamt Linkbeschriftung wie bei der Navigation innerhalb eines Buches oder bei Verweisen auf einen Wikipedia-Artikel.

Das geschieht mit Parametern, die beim Aufruf einer Vorlage angegeben werden (entweder mit Namen oder fortlaufend); mehrere Parameter werden durch das Pipe-Zeichen | getrennt.

{{w|Hilfe:Seite bearbeiten|Wikipedia-Hilfe}}
{{w|1=Hilfe:Seite bearbeiten|2=Wikipedia-Hilfe}}

Beide Varianten erzeugen die gleiche Ausgabe (mit fortlaufender Nummerierung der Parameter, im ersten Fall implizit, im zweiten Fall ausdrücklich angegeben), nämlich einen Link auf die  Wikipedia-Hilfe zu dieser Seite.

Mehr dazu siehe Vorlagen verwenden. Dort gibt es auch Hinweise zu weiteren Möglichkeiten und speziellen Vorlagen.

Vorlagen erstellen[Bearbeiten]

Eine Vorlage wird wie jede andere Wiki-Seite erzeugt, indem man einen Link auf einer Seite anlegt, dem Link folgt und die neue Seite bearbeitet und mit dem gewünschten Inhalt füllt. Je nach Art der Vorlage trägt man also etwas wie folgt ein:

{{Name der neuen Vorlage}}                                    <!-- für projektweite Vorlagen -->
{{:Regal:Mathematik/ Vorlage:Name der neuen Vorlage}}         <!-- für regalweite Vorlagen -->
{{:Mathe für Nicht-Freaks: Vorlage:Name der neuen Vorlage}}   <!-- für bucheigene Vorlagen -->

Ausführlich wird das unter Vorlagen erstellen beschrieben. Regeln für die Namen von Vorlagen stehen unter Vorlagen benennen.

Vorlagen erklären [Bearbeiten]

In aller Regel sind Zweck, Aufbau und Inhalt einer Vorlage zu dokumentieren, damit künftige Autoren erkennen, wo und wie sie verwendet werden kann. Dazu sollte man Vorlage:Dokumentation verwenden.

Ergänzend sollten Inhalte und Parameter so registriert werden, dass sie mit dem maschinenlesbaren Format JSON unter anderem beim VisualEditor verwendet werden können. Dazu dient die Parsererweiterung <templatedata>.

Mehr zur Dokumentation siehe Vorlagen erklären.

Lua[Bearbeiten]

Lua ist eine Skriptsprache, die du auf Wikibooks nutzen kannst, um deine Vorlage zu erstellen. Du findest eine Anleitung dazu unter Wikibooks:Lua.

Weitere Informationen[Bearbeiten]