Hilfe:Vorlagen
Aus Wikibooks
Hoch zum Lehrbuch
Vorlagen: Finden - Verwenden - Benennen - Erklären
Inhaltsverzeichnis |
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.
[Bearbeiten] 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 in den Abschnitten Finden und Benennen genannt.
[Bearbeiten] Erstellen von Vorlagen
Du kannst entweder erstellte Vorlagen benutzen (Übersicht) oder eine eigene Vorlage erstellen. Dabei gehst du so vor, als wolltest du ein neues Kapitel für ein Buch erstellen (siehe Hilfe:Neues Buch beginnen). Ein Unterschied besteht lediglich darin, dass du das Schlüsselwort Vorlage: voranstellen musst, also beispielsweise Vorlage:Name.
Für statische Vorlagen gilt das gleiche wie für Buchseiten. Man kann jedoch auch dynamische Vorlagen erstellen – mit Variablen, die den Inhalt von bestimmen Umständen abhängig machen. Da der Funktionsumfang hierbei aber stetig wächst, verweisen wir auf:
Vorlagenprogrammierung mit den ParserFunctions (befindet sich noch im Aufbau)
Hilfe:Vorlagen- Hilfe:Vorlagenprogrammierung
Help:Template- Help:Calculation
[Bearbeiten] Vorlage in Artikel einfügen
Vorlagen (im Vorlagennamensraum) können genutzt werden, indem man ihren Namen (ohne den Namenszusatz „Vorlage:“) in geschweifte Klammern setzt:
{{Name}}
{{subst:Name}}
Wenn du ‚subst:‘ verwendest, ersetzt die Software {{subst:Name}} durch den den Inhalt der Vorlage. Allerdings kann so der Inhalt auch nicht aktualisiert werden, falls die Vorlage verändert wird.
[Bearbeiten] Spezielle Vorlagen als Variablen der MediaWiki-Software
Die MediaWiki-Software verfügt über vordefinierte Vorlagen als Variablen. Eine Liste findest du bei m:Help:Magic Words (auf englisch). Hier ein kleiner Auszug:
| Vorlagenname | Aktueller Wert | Erklärung der Variable |
|---|---|---|
| {{PAGENAME}} | Vorlagen | Der aktuelle Seitenname als Zeichenkette |
| {{NUMBEROFARTICLES}} | 14.926 | Anzahl aller Wiki-Seiten |
| {{CURRENTDAY}} | 24 | Aktueller Tag innerhalb des Monats |
| {{CURRENTDAYNAME}} | Dienstag | Wochentag |
| {{CURRENTMONTH}} | 11 | Aktueller Monat als Nummerndarstellung |
| {{CURRENTMONTHNAME}} | November | Aktueller Monat in lesbarer Form |
| {{CURRENTYEAR}} | 2009 | |
| {{CURRENTTIME}} | 02:48 | |
| Hinweis: Die Zeitvariablen mit CURRENT liefern die UTC-Zeit. Möchtest du die aktuelle Zeit angeben lassen, ersetze CURRENT durch LOCAL, also beispielsweise statt CURRENTTIME LOCALTIME. |
||
[Bearbeiten] Von welchen Artikeln wird die Vorlage verwendet?
Wenn du wissen möchtest, welche Seiten eine Vorlage verwenden, klickst du in der Navigation links auf „Links auf diese Seite“. Achte darauf, dass du dir auch die Vorlage selbst anschaust!
[Bearbeiten] Vorlagen testen
Um Vorlagen zu testen, kannst du die dafür vorgesehene Vorlage:Spielwiese benutzen. Bitte denke daran, bei längeren Tests {{Bitte nicht ändern}} einzufügen und nach dem Spielen wieder zu entfernen.
[Bearbeiten] Kategorien innerhalb von Vorlagen einbinden
- includeonly
Will man eine Kategorie einer Buchseite automatisch über eine Vorlage einfügen (beispielsweise über eine Buch-eigene Navigationsleiste), dann möchte man meist nicht, dass die Vorlage selbst in der Kategorie auftaucht. Dieses kann man mit "includeonly" unterbinden.
- <includeonly>[[Kategorie: MeinBuch|{{PAGENAME}}]]</includeonly>
Je nach dem ob es für das Buchprojekt günstiger ist, kann man {{PAGENAME}} auch durch eine beliebige Zeichenkette ersetzen oder ergänzen, unter die entsprechende Buchseite abgespeichert wird. (Dieses empfiehlt sich bei einem Buchprojekt mit mehreren Bänden, oder bei größeren Kapiteln).
- noinclude
Andererseits kann es möglich sein, dass man verschiedene Vorlagen einer Kategorie zuordnen möchte, jedoch verhindern will, dass auch alle Seiten, in die eine Vorlage eingefügt werden, ebenfalls unter die Kategorie fallen. Dazu bindet man die Kategorie innerhalb "noinclude" ein, also dort, wo man auch allgemeine Kommentare zum Gebrauch der Vorlage aufschreiben kann, die aber nicht mit in die Seiten kopiert werden.
- <noinclude>[[Kategorie: MeinBuch/_Navigationsvorlage|{{PAGENAME}}]]</noinclude>
- onlyinclude
Normalerweise wird das, was in einer Vorlage eingetragen wurde, beim Anschauen der Vorlage auch angezeigt. Mitunter kann es aber sinnvoll sein, dass man dieses unterbindet. Um nur ein Beispiel zu nennen: Wenn mit der Vorlage nur einem unvollständiger Teil einer Tabelle in eine bestehenden Tabellenrahmen eingefügt werden soll, dann könnte es bei dem Anzeigen dieses unvollständigen Tabellenteils zu Darstellungsfehlern kommen.
- <onlyinclude> ... Inhalt ... </onlyinclude>
