Hilfe:Vorlagendokumentation

Im Folgenden sollen die im Delixs-Wiki verfügbaren Vorlagen dokumentiert werden, vorwiegend um eine allgemeine Übersicht zu bekommen. In der Regel ist eine Dokumentation auch auf der Seite der jeweiligen Vorlage zu finden. Eine vollständige (automatische) Auflistung gibt es auf der Seite Vorlage. Alle Vorlagen, die kategorisiert wurden, sind auch unter Kategorie:!Vorlagen gelistet. Hinweise zur allgemeinen Anwendung und Erstellung von Vorlagen bietet die Seite Hilfe:Vorlagen. Um eine Vorlage zu verwenden, notieren Sie {{, dann den Namen der Vorlage (optional mit Vorlage: davor), eventuelle Parameter mit dem Pipe-Zeichen | getrennt, und abschließend }}.

Beachten Sie: Wenn ein Parametertext ein = enthält, so ist dem gesamten Parameter ein 1= voranzustellen, wobei statt der 1 die jeweilige Position des Parameters anzugeben ist. {{Vorlagenname|1=Parametertext mit einem = drin.}}

Kleine Helfer

Farbe, Alias Color

Um Textstellen farblich zu kennzeichnen, kann diese Vorlage verwendet werden. Der erste Parameter ist eine Farbangabe, der zweite der zu färbende Text.

{{Farbe|red|rot gefärbter Text}}

Link-Bild

Um Bilder mit einem Link zu versehen, kann diese Vorlage verwendet werden. Eine genauere Beschreibung gibt es auf der Seite der Vorlage.

Üsim1, Üsim2, Üsim3, Üsim4, Üsim5, Üsim6

Überschriften-Simulation. Damit können Überschriften in Seiten simuliert werden, ohne dass sie, wie bei echten Überschriften, in Inhaltsverzeichnissen auftauchen. Außerdem wird kein anspringbarer Anker gesetzt.

{{Üsim1}}

!, !!, (!, !), !+, !-, !-!

Diese Vorlagen werden benötigt, wenn man innerhalb einer Vorlagenverwendung Tabellen erstellen möchte, da das Pipe-Zeichen | innerhalb einer Vorlage eine Sonderbedeutung hat und nicht direkt verwendet werden kann. (Siehe Problem: Senkrechter Strich in Parametern)

Clear

Aufhebung des Textumflusses bei gefloateten Elementen, beispielweise ein rechts- oder linksseitig angeordnetes Vorlage:TOC.

Präsentation von Dokumentationsinhalten

Iconset

Diese Vorlage zeigt die Plattformunterstützung an. Browser, die das Element ab der angezeigten Version unterstützen, werden hiermit aufgelistet.

Beispiel, BeispielCode, BeispielText, BeispielWiki

Diese Vorlagen dienen zum Einfügen von Beispielen in Dokumentationsseiten. Eine ausführliche Erklärung mit Beispielen gibt es auf der Seite Vorlage:Beispiel.

Beachten, Alias Beachten Sie

Beachten Sie: dass diese Vorlage einen Text in dieser Form darstellt, um beachtenswerte Hinweise zu kennzeichnen.

{{Beachten|Text}}

Empfehlung

Empfehlung: Verwenden sie diese Vorlage, um Empfehlungen (neudeutsch: best practice) auszusprechen.

{{Empfehlung|Text}}

TOC

Eine Vorlage um das Inhaltsverzeichnis (Table of Contents = TOC) zu beschränken oder zu platzieren. Siehe auch die Variablen mit TOC im Namen.

{{TOC|links}}, {{TOC|rechts}}, {{TOC|...|limit=x}}, {{TOC|limit=x}}

Fortsetzung

Für Artikel, die auf mehrere Seite aufgeteilt werden, kann mit dieser Vorlage eine Navigationsleiste eingefügt werden.

Eine ausführliche Anleitung gibt es unter Vorlage:Fortsetzung.

2Spalten

Kann für ein zwei-Spalten-Layout verwendet werden, beispielsweise auf Portal-Seiten.

{{2Spalten|Inhalt Spalte 1|Inhalt Spalte 2}}

Meta-Informationen, Zustand einer Seite

EditStatus

Seiten, die sich gerade in Bearbeitung finden, können mit dieser Vorlage entsprechend gekennzeichnet werden. Eine ausführlichere Beschreibung hält die Seite Hilfe:Status eines Artikels bereit. Eine Seite, die diese Vorlage enthält wird automatisch in die Kategorie ArtikelStatus aufgnommen.

Achtung, Hinweis, Info, ToDo

Mit Hilfe dieser Vorlagen können Meta-Informationen zu einer Seite eingefügt werden, also Informationen, vorwiegend für Bearbeiter aber auch Besucher, die nicht direkt zum Seiteninhalt gehören.

Löschen

Da das Löschen von Seiten den Administratoren vorbehalten ist, kann ein solcher mit dieser Vorlage darum gebeten werden. Sie kann auch gesetzt werden, wenn eine Diskussion zum Zwecke des Löschens angestoßen werden soll.

URLmove

Mitunter werden Seiten erstellt, die sich nicht an den Namenskonventionen im Delixs-Wiki orientieren. Der Ersteller soll damit darauf aufmerksam gemacht werden, einen geeigneteren Platz (insbesondere Namensraum) zu wählen.

Diverses

Autorbox

Auf Ihrer Benutzerseite können Sie Informationen zu sich selbst mit dieser Vorlage präsentieren. Auf anderen Seiten ist diese Vorlage nicht unbedingt sinnvoll, da eine Seite gemäß dem Wiki-Prinzip von jedem angemeldeten Benutzer geändert werden kann, also früher oder später nicht mehr nur einen Autor hat.