Hilfe:Vorlagen finden, verwenden und erstellen

Hoch zum Lehrbuch
Eine Vorlage ist eine Seite, die sich als Textbaustein verwenden lässt, d.h. als vorgefertigten Text, der in einen anderen Text eingefügt wird. Der Text und das Erscheinungsbild muss nicht starr sein, denn ein Textbaustein kann so konstruiert sein, dass sich Inhalt und Erscheinungsbild durch Variablen beeinflussen lassen.

Verwendungszweck

Vorlagen dienen in Wikibooks zur:

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

Die Konsistenzmaximierung und die Redundanzminimierung 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 drei Räume für Vorlagen:

• Projektweite Vorlagen (genau ein Raum)
• Regalweite Vorlagen (Zahl der Räume ist gleich der Regalanzahl)
• Bucheigene Vorlagen (Zahl der Räume ist gleich der Zahl der Bücher)

Einordnungskriterien sind im Abschnitt Finden genannt.

Benennen

Textbausteine sind im Prinzip ganz gewöhnliche Wiki-Seiten, die nur anhand ihrer Benennung als Vorlage gekennzeichnet werden. Die Einordnung in einen der drei Räume für Vorlagen geschieht über die Benennung.

Projektweite Vorlagen

Vorlagen, die im gesamten Projekt verwendet werden, sind nach dem Schema

Vorlage:Vorlagenname

benannt. Der kursiv gedruckte Teil ist variabel. Der Name sollte möglichst kurz und treffend sein.

Hinweis:

Vorlage/Vorlagenname

funktioniert nicht, nur der Doppelpunkt ist zulässig.

Um den Vorlagen-Namensraum überschaubar zu halten, sollen nur solche Vorlagen hinein, die für eine Vielzahl von Büchern verwendet werden können. Buchspezifische Vorlagen gehören in den Namensraum des jeweiligen Buches. Das hat den Vorteil, dass du deine Vorlage ändern kannst, ohne auf deren Verwendung in anderen Büchern Rücksicht nehmen zu müssen.

Regalweite Vorlagen

Dir ist sicherlich bekannt, dass Wikibücher in Regal-Seiten eingeordnet sind. Manche Textbausteine, denkbar ist zum Beispiel eine Vorlage zum Zitieren von Programmiercode, können nur innerhalb eines Regals sinnvoll eingesetzt werden. Die Vorlage Code für Bücher im Regal:Programmierung würde darum den Namen

Regal:Programmierung/ Vorlage:Code

tragen. Die Vorlagen werden immer nach dem Schema

Regal:Regalname/ Vorlage:Vorlagenname

benannt. Die zwei kursiv geschriebenen Ausdrücke sind variabel, der Rest ist fest. Wichtig ist vor allem, dass nach dem Regalnamen der Schrägstrich mit Leerzeichen folgt (nicht Doppelpunkt und Leerzeichen), sowie dass dem Wort Vorlage ein Doppelpunkt ohne nachfolgendes Leerzeichen folgt. Um sich das besser merken zu können, hier ein Hinweis: Das ganze kann aufgefasst werden als Teil des Vorlagennamensraums, der dem Regalnamensraum untergeordnet worden ist. Warum ist die Einhaltung dieses Schemas so wichtig? Weil dadurch das Auffinden erheblich vereinfacht wird, wie im Abschnitt Finden noch erklärt wird.

Bucheigene Vorlagen

Typischer Kandidat für bucheigene Vorlagen sind Navigationsleisten, die an das Layout bzw. den Inhalt des Buches angepasst sind. Ihre Benennung ist abhängig davon, ob das Buch zur Gliederung im Seitennamen den Schrägstrich oder den Doppelpunkt verwendet. So sieht jeweils das allgemeine Schema aus:

Buchname/ Vorlage:Vorlagenname

Buchname: Vorlage:Vorlagenname

Aus Gründen der Erleichterung des Auffindens mittels einer Spezialseite ist das Schema genau einzuhalten. Es ist nicht ratsam, Unterkapitel in den Namen mit einzubeziehen.

Buchname: Kapitel: Unterkapitel: Vorlage:Vorlagenname Bitte nicht machen.

Stelle die Vorlage mit

<noinclude>[[Kategorie:Bucheigene Vorlage]]</noinclude>

in die Kategorie Kategorie:Bucheigene Vorlage.

Finden

Der übliche Weg, wie man auf eine Vorlage aufmerksam wird, ist sicherlich das Auffinden in einem Buch. Ist man hingegen auf der Suche nach einer Vorlage für eine spezielle Aufgabe, ist dieser Weg mühsam. Niemand wird sich die Arbeit machen wollen, einen Großteil der Seiten von Wikibooks zu durchforsten. Darum gibt es Übersichtslisten.

Auffinden in Büchern

Alle in eine Seite eingebundenen Vorlagen werden als Links unter dem Bearbeiten-Fenster aufgelistet. Öffne Regal:EDV in einem neuen Fenster. Klicken dann auf bearbeiten und scrolle ganz nach unten. Dort steht so etwas wie:

In diesem Artikel verwendete Vorlagen:

• Vorlage:Grafiken geben Fortschritt an
• Vorlage:Status

Klick einfach die Links an bzw. öffne sie in einem neuen Fenster. Meist wirst du dort eine Anleitung finden. Gibt es so etwas nicht, lies weiter im Abschnitt Verwenden.

Auffinden in Listen

Für die Übersicht über projektweite Vorlagen werden Kategorieseiten genutzt, für regal- bzw. bucheigene Vorlagen eine Spezialseite.

Projektweite Vorlagen

Wenn du eine Kategorieseite öffnest, siehst du eine Auflistung aller Vorlagen. Mit einem Klick auf eine Vorlage landest du direkt auf der Vorlagenseite. Dort solltest du eine Beschreibung bzw. einen Link darauf vorfinden, der dir hilft, den Verwendungszweck der Vorlage zu verstehen. Ansonsten besteht auch die Möglichkeit, die Vorlagen auf der Spielwiese auszuprobieren. Wie das geht wird im Abschnitt Verwenden erklärt.

Nachfolgend ist die Übersicht über die Kategorien für projektweite Vorlagen gegeben. Sie beginnt mit den zwei Kategorien, die für die Gestaltung von Büchern interessant sind.

• Buchgestaltung: Enthält alle Textbausteine für die Gestaltung der Buchseiten, also z.B. Links auf Schwesterprojekte, Hervorhebungen, usw., jedoch keine Vorlagen für Einrichtung einer Buchnavigation.
• Navigation: Sie enthält alle Vorlagen, die so allgemein gehalten sind, dass sie sich in jedem Buch für die Navigation zwischen den Seiten eignen. Gerne erstellen Wikibooks-Autoren aber individuelle, grafisch ansprechende Navigationen. Sind die projektweiten Navigationsvorlagen nicht ansprechend genug, dann sieh Dir die buchspezifischen Navigationsvorlagen an. Wie und wo du sie findest, wird noch erklärt.

Buchgestaltung ist das eine, andere Bereiche, in denen bestimmte Texte immer wieder verwendet werden, sind die Klärung von Lizenzfragen und die Projektkoordination.

• Lizenzfragen: Hier findest du Textbausteine, um die Lizenz der von Dir hochgeladenen Bilder anzugeben. Daneben gibt es weitere Vorlagen, die zur Angabe der Autoren eines unter GNU-FDL stehenden, von Dir importierten Text, dienen.
• Projektarbeit: Die Inhalte dieser Kategorie sind sehr vielseitig. Gemeinsam haben sie, das sie die Arbeit auf Wikibooks erleichtern. Schau sie Dir einfach mal an.

Möchtest du deine eigenen Vorlagen entwickeln, so lohnt ein Blick auf die folgenden zwei Kategorien:

• Vorlagen für technische Aufgaben: Sie werden in andere Vorlagen eingebaut, um z.B. die Zahl der zu übergebenden Variablen zu flexibilisieren. Im Prinzip gehören in diese Kategorie auch Pseudovariablen. Weil es aber so viele davon gibt, sind die Pseudovariablen in einer eigenen Kategorie erfasst.
• Pseudovariablen: Pseudovariablen stellen eine Erweiterung der von der Wiki-Software angebotenen Variablen dar. Die Original-Variablen sind in der Wikipedia auf der Seite Hilfe:Variablen beschrieben.

Alle weiteren projektweiten Vorlagen befinden sich in der Kategorie Sonstige Vorlagen.

Regalweite Vorlagen

Auf der Diskussionsseite des Regals befindet sich wahrscheinlich ein rot eingefasster Link auf die Liste der Vorlagen des Regals. Ist dem nicht der Fall gehst du wie im Folgenden beschrieben vor. Zur Suche wird die Spezialseite Spezial:Prefixindex verwendet. Dort ist im Dropdown-Menü der Namensraum Regal auszuwählen, im darüber befindlichen Fenster "Seiten anzeigen mit Präfix" wird

Regal:Regalname/ Vorlage

eingetragen. Die Betätigung des Buttons listet, wenn die Namenskonvention immer eingehalten worden ist, alle Vorlagen des Regals auf. Zum Vergleich: Die Betätigung dieses Links zeigt alle vorlagen des Regals Sport: Spezial:Prefixindex/Regal:Sport/_Vorlage. Wird eine Vorlage vermisst, dann probiert mal

Regal:Regalname/Vorlage
Regal:Regalname: Vorlage
Regal:Regalname:Vorlage

aus. Wenn ihr damit Vorlagen findet, behebt den Missstand bitte gleich durch Verschieben und Ersetzen. Dem aufmerksamen Leser wird auffallen, dass zur Funktion der Suche die Einhaltung des Benennungsschemas ab dem Doppelpunkt nach "Vorlage" nicht notwendig ist. Es wäre trotzdem nicht schlecht, wenn wir das Einhalten, ich könnte mir denken, dass wir dadurch in ferner Zukunft ein paar hilfreiche Automatisierungen einführen können. Z.B. ist es denkbar, die Software erkennen zu lassen, in welchem Kontext eine Vorlage eingesetzt wird. Statt {{Buchname/ Vorlage:Navigation}} braucht man nur noch {{Navigation}} einzugeben. Gibt es eine bucheigene Navigation, wird diese verwendet, ansonsten wird die übergeordnete Navigation verwendet. Die Umsetzung wird zwar nicht unmöglich, aber doch viel mühseliger, wenn jeder nach seinen eigenen Standards benennt.

Ein Klick auf die Vorlagen in der Liste öffnet die Vorlagenseite, auf der sich im Idealfall eine Anleitung mit Beispielen befindet.

Bucheigene Vorlagen

Auf einer der Projektseiten des Buchs befindet sich wahrscheinlich ein rot eingefasster Link auf die Liste der Vorlagen des Buchs. Eine Übersicht über die Projektseiten findest du hier. Oft ist auch die Diskussionsseite identisch mit der Projektseite. Hast du den roten Kasten nicht gefunden, verläuft die Suche nach bucheigenen Vorlagen analog zur Suche nach regalweiten Vorlagen. Auf der Seite Spezial:Prefixindex wird der Namensraum "(Haupt-)" ausgewählt, in das Textfeld wird

Buchname: Vorlage

bzw.

Buchname/ Vorlage

eingetragen. Hier kann man das einmal nachvollziehen: Spezial:Prefixindex/Blender3D:_Vorlage.

Ein Klick auf die Vorlagen in der Liste öffnet die Vorlagenseite, auf der sich im Idealfall eine Anleitung mit Beispielen befindet.

Alternativ kann auch in Kategorie:Bucheigene Vorlage gesucht werden.

Verwenden

Die Verwendung sollte die Anleitung auf der Vorlagenseite erklären. Ist das nicht der Fall oder wird dort grundlegendes Wissen vorausgesetzt, ist dieser Abschnitt der Richtige für dich. Wenn Dir dieser Abschnitt nicht weiterhilft, setze dich mit der Erstellung von Vorlagen auseinander. Mancher einfach aussehende Textbaustein besteht aus mehreren miteinander verschachtelten Vorlagen. Hast du eine der Vorlagen der Zwischenschicht erwischt, wird sie nicht das von dir erhoffte Ergebnis liefern! Alle die, die selber Vorlagen erstellen wollen, sollten diesen Abschnitt ebenfalls lesen.

Vorlagen ohne Variablen

Zunächst einmal wollen wir den einfachsten Fall betrachten, der da ist, dass der Vorlage keine Variablen übergeben werden müssen.

Projektweite Vorlagen

Unser Ziel ist es, die Vorlage:Bitte nicht ändern in die Spielwiese einzubinden. Rufe dazu die Spielwiese in einem neuen Fenster auf, öffne sie zum Bearbeiten und gib

{{Vorlage:Bitte nicht ändern}}

ein. Speichere die Seite ab. Du siehst, dass der Textbaustein jetzt auf der Seite erscheint. Öffne anschließend die Seite zum Bearbeiten und entferne den Baustein wieder. Dir ist bestimmt aufgefallen, dass wir nicht {{Vorlage:Bitte nicht ändern}} haben schreiben müssen, was übrigens auch funktionieren würde.

Nun kommen wir zu einem wichtigen Zusatzbefehl, der es uns ermöglicht, den Text der Vorlage, der nicht der Dokumentation der Vorlage dient, in eine Seite zu schreiben. Öffne wieder die Spielwiese in einem neuen Fenster, gib

{{subst:Bitte nicht ändern}}

ein und speichere. Öffne anschließend wieder zum Bearbeiten. Du siehst, dass der neue Text in der Spielwiese identisch ist mit dem Textkörper der Vorlage:Bitte nicht ändern, der nicht von den Tags <noinclude> und </noinclude> umschlossen ist. Manche Vorlagen können übrigens nur mit dem subst:-Befehl sinnvoll verwendet werden, so zum Beispiel die Vorlage:Datum. Gib in der Spielwiese

{{subst:Datum}}
<br />
{{Datum}}

ein und speichere. Das Ergebnis sieht im Prinzip so aus:

9.06.2006
{{subst:CURRENTDAY}}.{{subst:CURRENTMONTH}}.{{subst:CURRENTYEAR}}

Nur mit subst hat es funktioniert. Was die Verwendung von subst allgemein gesehen an Vor- bzw. Nachteilen bringt, wird bei der Vorlagenerstellung erörtert.

Regalweite und bucheigene Vorlagen

Nun wollen wir die selbe Prozedur mit einer Bucheigenen Vorlage, der Vorlage Blender3D: Vorlage:Difficulty wiederholen. Teste einmal

{{Blender3D: Vorlage:Difficulty}}

{{:Blender3D: Vorlage:Difficulty}}

sowie

{{subst:Blender3D: Vorlage:Difficulty}}

{{subst::Blender3D: Vorlage:Difficulty}}

auf der Spielwiese. Du siehst, dass es nur dann funktioniert, wenn du einen Doppelpunkt voran stellst.

Regalweite Vorlagen

{{Regal:Programmierung: Vorlage:Code}}

geht genauso wie

{{:Regal:Programmierung: Vorlage:Code}}

Dies liegt daran, das Regal ein eigener Namensraum ist.

Merksätze

1. Um Vorlagen einzubinden, fasst man sie in geschweifte Klammern.
2. Bei projektweiten Vorlagen kann man einen Teil des Namens weglassen, bei bucheigenen Vorlagen muss man noch einen Doppelpunkt vorne anstellen.
3. Die Erklärung auf der Vorlagenseite wird nicht mit eingebunden.
4. Mit dem Befehl subst: wird der momentane Inhalt in die Seite geschrieben.

Einbindung von Nicht-Vorlagen

Das Spielchen mit dem vorangestellten Doppelpunkt kann man natürlich auch mit Seiten treiben, die keine Vorlagen sind. Du kannst ja spasseshalber mal unsere Hauptseite mit {{:Hauptseite}} in die Spielwiese einbinden. Es funktioniert! In welchen Fällen es sinnvoll ist, statt einer Vorlage eine normale Seite anzulegen und einzubinden, werden wir bei der Erstellung noch erörtern.

Neuerstellen

Zuerst überlegen

• Vor- und Nachteile von subst erörtern.
• {{msgnw:Titel}} zeigt im Artikel den Quellcode der Vorlage an. Diese Funktion wird selten, eigentlich nur zur Erklärung von Vorlagen, gebraucht.

Optionale Angabe

Beispiel: {{{Untertitel|}}}

Das "|" sorgt dafür das die "Untertitel"-Angabe optional ist.

Intelligente Vorlagen

Da der Funktionsumfang regelmässig wächst, macht es nicht viel Sinn, hier Lokal eine Dokumentation zu führen.

In diesem Sinne folgende Verweisse:

• Help:Calculation
• Hilfe:Vorlagenprogrammierung

Dann erstellen

Es gibt mehrere Wege zu einer neuen Vorlage:

• Du öffnest ein Kapitel, in dem die Vorlage benutzt werden soll, zur Bearbeitung. Trage die Vorlage so ein, wie es oben bei Verwenden beschrieben ist, beispielsweise durch {{Was ich will}} und aktiviere die Vorschau. Am Ende der Seite stehen alle verwendeten Vorlagen – deine neue wird mit einem roten Link angezeigt.
• Oder du trägst in die Suchfunktion zu Wikibooks "Vorlage:Was ich will" ein. Dann wird dir direkt angeboten, die Seite neu zu erstellen.

Dann wird auf der neuen Seite [[Vorlage:Was ich will]] alles in Wiki-Quelltext eingetragen, was die Vorlage anzeigen soll – ggf. auch mit Varianten.

Alternativ kannst du auch umgekehrt vorgehen: Schreibe im Kapitel alles rein, was später zur Vorlage werden soll, bis die Anzeige deinen Vorstellungen entspricht. Dann erzeuge die neue Vorlage und kopiere den Text dorthin.

Oder du benutzt dafür zunächst die Vorlage:Spielwiesenvorlage. Danach erzeuge die neue Vorlage und kopiere den Text dorthin.