Help:Templates
|
|
Vorlagen sind eine feine Sache, denn wenn sie einmal angelegt sind, können sie auf beliebig vielen anderen Seiten eingebaut werden. In der Hortipedia ermöglichen sie unter anderem:
Vorlagen sind nicht geeignet für:
Wie gesagt, Vorlagen sind eine feine Sache, allerdings sollte aus Gründen der Übersicht darauf geachtet werden, dass keine doppelten oder sehr ähnlichen Vorlagen angelegt werden. Vor dem Erstellen einer neuen Vorlage sollte man also erst einmal schauen, ob schon eine vorhandene Vorlage besteht, die den gleichen Zweck erfüllt. |
Contents |
Schritt für Schritt
Eine Vorlage zu erstellen ist eigentlich auch nicht komplizierter als das normale Formatieren einer Seite. Das grundsätzliche Konzept der sogenannten Stylesheets, also Begriffe wie text-align, margin-bottom oder float, die zur Erstellung und Bearbeitung der Vorlagen verwendet werden, wird auf der Seite Hilfe:CSS erklärt. Angenommen, man hat nun mit folgender Eingabe auf einer Seite die darunterstehende Box erzeugt:
<div style="border:1pt solid #9b9b9b;text-align:center; padding-left:5pt;background-color:#d7e4d5;margin-bottom:0pt;border-bottom-style:none"> '''Gartenzitat'''</div> <div style="border:1pt solid #9b9b9b;margin-top:0pt;padding:5pt"> Unkraut ist alles, was nach dem Jäten wieder wächst. - Mark Twain -</div>
Erstellen
Wenn man obige Box genau so auf anderen Seiten einfügen möchte, kann man sie jetzt speichern, indem man eine neue Seite anlegt, zum Beispiel Vorlage:Zitat Mark Twain, und den Quelltext hineinkopiert. Vielleicht möchte man aber auf einer anderen Seite die gleiche Box verwenden, allerdings mit anderem Inhalt. Dafür muss man die Elemente, die veränderbar sein sollen, für die Software markieren, in diesem Fall sind das der Titel und der Fließtext. Anstelle von "Gartenzitat" schreibt man das Wort "titel" und setzt es in jeweils drei geschweifte Klammern. So erkennt das System, dass "titel" nur ein Platzhalter ist. Analog ersetzt man den Fließtext in der unteren Box durch {{{text}}}
<div style="border:1pt solid #9b9b9b;text-align:center;
padding-left:5pt;background-color:#d7e4d5;margin-bottom:0pt;border-bottom-style:none">
'''{{{titel}}}'''</div>
<div style="border:1pt solid #9b9b9b;margin-top:0pt;padding:5pt">
{{{text}}}</div>
Das Ergebnis sieht dann so aus:
Diese Seite kann man jetzt als "Vorlage:xxx" (xxx durch einen aussagekräftigen Namen ersetzen) anlegen. In unserem Fall bekommt sie den Namen "Vorlage:Zitatbox". Vorlagen haben in der MediaWiki einen eigenen Namensraum, deshalb muss beim Anlegen einer neuen Vorlage immer Vorlage: vor dem Namen stehen.
Einfügen
Auf einer anderen Seite kann man die Vorlage jetzt einsetzen, indem man den Namen in zwei geschweifte Klammern setzt,also {{Zitat Mark Twain}}. Dann erscheint folgendes:
Für das Einfügen der Vorlage mit variablen Parametern ist die Eingabe analog {{Zitatbox}}. Es erscheint die Box, so wie man sie in der Vorlage gespeichert hat.
Um nun anstatt des Platzhalters "titel" einen Text einzufügen, setzt man nach dem Namen der Vorlage einen Hochstrich | und teilt dem Programm mit titel=xxx mit, wodurch es ihn ersetzen soll. Gleiches gilt natürlich auch für "text". Im Programmierfenster kann das zum Beispiel so aussehen:
{{Zitatbox
|titel=Wilhelm Busch
|text=Wem Mutter Natur ein Gärtchen gibt und Rosen, dem gibt sie auch Raussen und Blattläuse,
damit er's verlernt, sich über Kleinigkeiten zu entrüsten.}}
Und das Ergebnis davon ist das:
Übrigens
Seiten, die nicht im Namensraum Vorlage stehen, lassen sich ebenso als Vorlage verwenden, wenn man den Namensraum mit angibt. Zum Beispiel würde {{Hortipedia:Hortiquette}} die Seite Hortipedia:Hortiquette als Vorlage einbinden. Will man eine Seite aus dem Artikelnamensraum einbinden, muss man allerdings noch einen Doppelpunkt vor den Namen setzen: So würde {{:Rose}} beispielsweise den Artikel "Rose" als Vorlage einbinden.
Gestaltungsmöglichkeiten
Das oben durchgespielte Beispiel ist ein relativ einfaches, denn analog zum Inhalt lassen sich natürlich auch die anderen Parameter der Vorlage zum nachträglichen Verändern einrichten. Um die Hilfe übersichtlich zu halten wird das hier an drei Beispielen erklärt.
Beispiel Textausrichtung
Möchte man sich die Möglichkeit offen halten, beispielsweise den Titel anders auszurichten, so ersetzt man text-align:center durch text-align:{{{text-align}}} Beim Einfügen kann man dann mit der Eingabe |text-align=left dieses Ergebnis erzielen:
Beispiel Breite
Möchte man die Breit der Box nachträglich ändern, fügt man in der Vorlage width{{{width}}} hinzu. Beim Einfügen der Vorlage bestimmt man dann beispielsweise den Wert |width=40% und voilá:
Beispiel Positionieren
Vielleicht möchte man die Box aber auch mal auf der rechten Seite haben. In diesem Fall braucht man in der Vorlage den Befehl
float:{{{float}}} Gibt man hierfür dann |float=right ein, erscheint sie am rechten Rand ausgerichtet. Das ist natürlich nur sichtbar, wenn sie nicht 100% breit ist.
Das waren also drei Beispiele, was man mit Vorlagen
so alles anstellen kann.
Was kann man wann sehen?
Es gibt drei Befehle, die bei der Erstellung von Vorlagen sehr wichtig sind, da sie festlegen, welche Information wie und wo verarbeitet wird:
<onlyinclude>
- Wenn man sich die Vorlage direkt anschaut, haben <onlyinclude> und </onlyinclude> keine Wirkung auf das, was dazwischen steht. Wenn die Vorlage jedoch auf einer anderen Seite eingebunden ist, wird ausschließlich angezeigt, was zwischen <onlyinclude> und </onlyinclude> steht. So habe wir beispielsweise unsere "Zitatbox" der Kategorie "Vorlage" zugeordnet. Nun soll aber natürlich nicht jede Seite, in der diese Vorlage verwendet wird, der Kategorie "Vorlage" zugeordnet werden, weshalb [[Kategorie:Vorlage]] außerhalb von <onlyinclude> steht.Es können auch mehrere nicht-verschachtelte <onlyinclude>-Blöcke in einer Vorlage stehen.
<includeonly>
- Alles, was in einer Vorlage zwischen <includeonly> und </includeonly> steht, wird nur dann angezeigt, wenn die Vorlage auf einer anderen Seite eingebunden wird. Mit <includeonly> lassen sich zum Beispiel alle Seiten, die eine bestimmte Vorlage enthalten, automatisch einer Kategorie hinzufügen. Vielleicht möchten wir ja, dass jede Seite, auf der unsere "Zitatbox" verwendet wird, automatisch der Kategorie "Zitat" zugeordnet wird. Für die Vorlage selbst trifft das aber natürlich nicht zu, also steht [[Kategorie:Zitat]] hier in <includeonly>.
<noinclude>
- ist das Gegenteil von <onlyinclude>, das heißt alles, was in einer Vorlage zwischen <noinclude> und </noinclude> steht, wird nur dann angezeigt, wenn die Vorlage selbst betrachtet wird. Verwendung findet der Befehl, wenn im Text der Vorlage etwas steht, das nicht mit ausgegeben werden soll. Für das Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien, etc. ist <onlyinclude> besser geeignet. <noinclude> kann auch in <onlyinclude>-Blöcken stehen.
Gut zu wissen
- Variable: In MediaWiki gibt es verschiedene vordefinierte Variable, die automatisch einen bestimmten Inhalt anzeigen. So kann beispielsweise mit {{PAGENAME}} der Seitenname eingefügt werden. Wird diese Variable in einer Vorlage verwendet, erscheint hier immer der Name der Seite, in die die Vorlage eingefügt wird. Eine Liste und Erklärung der Variablen und der sogenannten magic words findet sich auf Hilfe:Variablen.
- Standard-Parameter: Man kann Parameter auch so definieren, dass für sie bei Gebrauch der Vorlage kein Wert angegeben werden muss. Ohne diese Angabe findet dann ein vorher definierter Wert Verwendung. Bei einem Konstrukt wie {{{titel|{{PAGENAME}}}}} wird also der Seitenname ausgegeben, wenn für titel keine Eingabe erfolgt.
- Aufzählungszeichen wie das am Anfang dieser Zeile, können als Parameterwert verwendet werden. Dafür muss in der Vorlage vor dem Parameter eine neue Zeile begonnen werden.
Dokumentieren
Vorlagen, die in normalen Artikeln verwendet werden, sollten so einfach gestaltet sein, dass Zweck und Anwendung unmittelbar verständlich sind. In jedem Fall ist eine Beschreibung der Funktion sinnvoll, damit auch andere Benutzer etwas damit anfangen können. Hierfür bitte immer die Vorlage:Formatvorlage Vorlage verwenden.
Kategorisieren
Damit eine erstellte Vorlage auch von anderen Hortipedianern gefunden werden kann, sollte sie in die [[Kategorie:Vorlage]] eingeordnet werden. Für die alphabetische Sortierung setzt man noch den Namen der Vorlage dahinter, also [[Kategorie:Vorlage|Zitatbox]]. So wird die Seite "Vorlage:Zitatbox" im Inhaltsverzeichnis der Vorlagen unter "Z" wie Zitatbox einsortiert und nicht unter "V" wie Vorlage. Bei der Zuweisung von Kategorien muss man daran denken, dies innerhalb von <noinclude> oder außerhalb von <onlyinclude> zu tun, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird.
Die Regeln zur Kategorisierung in den verschiedenen Namensräumen sollten unbedingt eingehalten werden.
