Hilfe:Vorlagen

Hoch zum Lehrbuch

Vorlagen: FindenVerwendenBenennenErstellenErklären


Wikibooks hat das Lehrbuch:

Eine Vorlage ist eine Seite, die als vorgefertigter Block (Inhalt, Formatierung oder beides) in eine andere Seite eingefügt wird. Der Text und das Erscheinungsbild müssen nicht fest vorgegeben sein, denn mit einer Vorlage können Inhalt und/oder Erscheinungsbild durch Variablen beeinflusst werden.

VerwendungszweckBearbeiten

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 eine Autorin prägnant anderen Autoren mitteilen, in welche Richtung ein Kapitel verbessert werden sollte.
    Beispiele: Vorlage:Übersetzen, Vorlage:Löschen
  • Vereinfachung grafischer Darstellung: Manch schöne Darstellung lässt sich nur mit einem unschönen Mix aus Wikibefehlen und HTML- bzw. CSS-Befehlen erreichen. Der Wikiquellcode eines Kapitels wird dann schnell unübersichtlich und ist für Anfänger quasi nicht mehr lesbar. Damit erhöht sich die Hürde, sich an der weiteren Verbesserung eines Kapitels zu beteiligen. Hier kann eine Vorlage helfen, den Kapitelquellcode lesbarer zu gestalten.
    Beispiel: Vorlage:Formel

Bereiche von VorlagenBearbeiten

Aktuell müssen bei Wikibooks nicht alle Bücher dasselbe Erscheinungsbild haben. 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:

  • Wikibooksweite 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 üblicherweise mit dem Namen des Buchs, gefolgt von einem Trennzeichen und dem Wort "Vorlage"; sie gehören üblicherweise 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 verwendenBearbeiten

Eine Vorlage wird mit {{Name der Vorlage}} (also mit doppelten geschweiften Klammern) in den Text des Kapitels eingesetzt. 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 ( ) 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 folgenden Link zu dieser Seite:   Wikipedia-Hilfe

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

Vorlagen erstellenBearbeiten

Eine Vorlage kann wie jede andere Wiki-Seite erzeugt werden, indem man sie auf einer Seite nutzt, dem entstehenden roten Link folgt, die neue Seite bearbeitet und mit dem gewünschten Inhalt füllt. Je nach Art der Vorlage trägt man also z. B. ein:

Tabellenlegende: fettgedruckt → von Autorin zu wählen; kursiv → notwendig oder Namenskonvention
{{Name der neuen Vorlage}} <-- für wikibooksweite Vorlagen -->
{{:Regal:Regalname/ Vorlage:Name der neuen Vorlage}} <-- für regalweite Vorlagen -->
{{:Buch: 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.

LuaBearbeiten

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

Weitere InformationenBearbeiten