Hilfe:Wiki/MediaWiki/Vorlagen

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche
Eine Vorlage ist eine Seite, die sich als Textbaustein verwenden lässt, d. h. als vorgefertigter Text, der in einen anderen Text eingefügt wird.

Im Folgenden sollen die im SELFHTML-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.

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.}}

Boxen

Info-Boxen

Kästen mit role="complementary", die den Hauptinhalt mit zusätzlicher Information ergänzen.

Beachten Sie: Sollten die nicht die gleiche Farbe wie die TOCs und die Sidebar kriegen? --Matthias Scharwies (Diskussion)
Info
Mit dieser Vorlage können Sie eine Information hervorheben. Sie wird über die ganze Seitenbreite dargestellt. Optional können Sie ein aside hinzufügen, um die Box nach rechts auszurücken.
{{Info|Informationen mit einem [[Hilfe:Farbtabelle|Textlink]].}}
{{Info|aside|Diese Information steht am Rand}}

Text-Info
Diese Vorlage bietet Ihnen die Möglichkeit, eine kurze Information über die Lesedauer und die Inhalte eines Artikels zu geben
{{Text-Info|30min|Anfänger|Grundkenntnisse in<br>• HTML<br>• CSS|Video=DMZDKKPo54o Titel}}
Die Textbox ist mit float nach rechts eingerückt, der Artikeltext läuft links davon normal weiter. Wenn Sie ab einem bestimmten Punkt sicherstellen möchten, dass der Artikeltext wieder über die ganze Breite geht, löschen Sie das Floating mit der Vorlage {{clear}}. So wie jetzt...

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.
{{Autorbox|in|Marie Mustermann|marie@example.com|http://www.example.com|example}}

Aside
Entspricht vom HTML-Markup einem rechts positionierten TOC und kann genutzt werden, um eine Informationsbox aus dem Text auszurücken.
{{Aside|
* '''[[Wie fange ich an?]]''' ''{{Farbe|#5a9900|(neu)}}'' 
** weitere [[Link]]s
** weiterer Text
}}

Hinweise und Warn-Boxen

Kästen mit role="note" als Ergänzung zum Hauptinhalt

Hinweis:
Text mit einem nicht sicherheitskritischen Hinweis.
ein Textlink.

{{Hinweis|Text}}

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

{{Empfehlung|Text}}

Aufgabe: bla

Lösung

Lösungstext mit einem Textlink.
Beachten Sie: dass diese Vorlage einen Text in dieser Form darstellt, um beachtenswerte Hinweise zu kennzeichnen.
Beachten Sie, dass
... mit einem Textlink.
Achtung, ToDo

Achtung!

Sicherheitskritischer Hinweis, der bei Nichtbeachtung zu Fehlern führt.
ein Textlink.

ToDo (weitere ToDos)

Demo-Todo!

Verlinkungen und Navigationen

Links auf andere Tutorials werden künftig ohne Vorlage notiert:

Kästen mit role="navigation", die auf andere Seiten verweisen.

Diese Seite ist eine Begriffsklärung zur Unterscheidung mehrerer mit demselben Wort bezeichneter Begriffe.


Zu diesem Stichwort ist kein Artikel vorhanden; möglicherweise ist Test gemeint.


Für Kurse, die auf mehrere Seiten aufgeteilt werden, kann mit Vorlage:Fortsetzung eine Navigationsleiste eingefügt werden.

Beispiele

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.
Beispiel
Code
Text mit einem Textlink.
Wikitext
Beispiel ansehen …
Code
Text
Wikitext

Kombinationen

Beachten Sie:
Beispiel ansehen …
Code
Text
Wikitext

Eine Verschachtelung von Vorlagen ist möglich, aber mittlerweile nicht mehr gewollt.

Besser wäre ein Einsatz von Codingstyle wrong oder eine nachfolgende Achtung-Box.

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}}
!, !!, (!, !), !+, !-, !-!
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.
Iconset
Diese Vorlage zeigt die Plattformunterstützung an. Browser, die das Element ab der angezeigten Version unterstützen, werden hiermit aufgelistet.
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}}

Hauptartikel: Hilfe:Wiki/Inhaltsverzeichnis

Mehrspaltenlayout

2Spalten
Kann für ein zwei-Spalten-Layout verwendet werden, beispielsweise auf Portal-Seiten.
{{2Spalten|Inhalt Spalte 1|Inhalt Spalte 2}}
3Spalten
Kann für ein drei-Spalten-Layout verwendet werden, beispielsweise auf Portal-Seiten.
{{3Spalten|Inhalt Spalte 1|Inhalt Spalte 2|Inhalt Spalte 3}}
nSpalten
erzeugt eine Darstellung in n Spalten, die jeweils eine Mindestbreite von 20em haben. Um die Verteilung des Inhalts in die Spalten muss man sich nicht kümmern. Als zusätzlicher Parameter kann eine abweichende Breite angegeben werden.
{{nSpalten|4|Inhalt}}
{{nSpalten|4|min-width=10em|Inhalt}}

Siehe auch