Hilfe:Vorlagen

Aus KKWiki
Wechseln zu:Navigation, Suche

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. Die Hilfebox rechts zeigt eine Übersicht über Vorlagen, die in Artikeln verwendet werden.

Vorlagen verwenden

Geschweifte Klammern

Um eine einfache Vorlage in einem Artikel zu verwenden, gibt es drei Möglichkeiten:

  1. Im Hauptanwendungsfall fügst du eine Vorlage mit

{{Titel}} ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage „Titel“. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung.

{{subst:Titel}} fügt ebenfalls den Inhalt der Vorlage ein, ersetzt den Text jedoch direkt beim Speichern durch die Vorlage. Auf diese Art werden zum Beispiel neue Benutzer begrüßt, die anschließend auf ihrer Seite auch beim Bearbeiten den Text der Begrüßung vorfinden sollen und kein verwirrendes {{Hallo}}. Andere Vorlagen sind so konstruiert, dass man sie mit {{subst:Titel}} einbindet, z. B. die Vorlage Löschantrag.

{{msgnw:Titel}} zeigt im Artikel den Quellcode der Vorlage an. Diese Funktion wird selten, eigentlich nur zur Erklärung von Vorlagen, gebraucht.

Seiten, die nicht im Namensraum Vorlage stehen, lassen sich ebenfalls als Vorlage verwenden, wenn man den Namensraum angibt.

Parameter einfügen und verwenden

Oft sollen in einer Vorlage noch Inhalte auftauchen, die sich von Seite zu Seite ändern, zum Beispiel eine Unterschrift oder der Name des Bildes auf den Commons in der Vorlage:NowCommons. Das geschieht mit Parametern.

Wenn du eine solche Vorlage mit Parametern verwenden willst, gibst du nach dem Namen der Vorlage, getrennt mit einem senkrechten Strich, die Werte an:


Einsatzmöglichkeiten

Vorlagen sind nur dann sinnvoll, wenn es von ihnen nur eine überschaubare Anzahl gibt, die sich Benutzer auch merken können. Insbesondere sollten Vorlagen nicht doppelt oder sehr ähnlich entstehen.

Vorlagen 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 ihrer Funktion notwendig. Dies kann im noinclude-Bereich der Vorlagenseite geschehen. Bei häufig eingebundenen Vorlagen sollte die Funktionsbeschreibung jedoch besser auf einer separaten Seite stehen; auf diese kann dann mithilfe der Vorlage:Dokumentation noinclude-Bereich der Vorlagenseite verwiesen werden. Eine Änderung der Vorlagenseite selbst bewirkt nämlich, dass alle davon abhängigen Seiten bei einem erneuten Aufruf neu generiert werden müssen, anstatt sie aus dem Cache laden zu können. Diese Serverlast sollte vermieden werden. Die vorstehende Überlegung ist allerdings auch nur relevant, wenn mit Überarbeitungen der Dokumentation bei unveränderter Funktion zu rechnen ist; das Auslagern der Dokumentation verbessert jedoch ohnedies die Übersichtlichkeit.

Ausführliche Dokumentation auf einer Unterseite

Für eine ausführliche Dokumentation eignet sich eine Unterseite der Vorlage. Die Vorlage:Vorlagendokumentation sollte nicht mehr verwendet werden.

Kategorisierung

Jede Vorlage sollte in entsprechende Unterkategorien der Kategorie:Vorlage: und die passendste thematische Kategorie (sofern sinnvoll) eingeordnet werden.

Andere Quellen / Wikipedia
Dieser Artikel basiert auf einem Artikel aus der freien Enzyklopädie Wikipedia, in der Wikipedia ist eine Versionsliste der am Artikel beteiligten Autoren / Historie zum Zeitpunkt der Übernahme der Ursprungsversion verfügbar.

Die hier letzte gültige Version (Siehe Versionen/Autoren (Historie)) wurde hier zuletzt am 11.06.2014 von Lugsciath auf KKWiki als Mit-Autor modifiziert und steht unter der GNU-Lizenz für freie Dokumentation (GFDL), der (neue) Titel ist gemäß GFDL (hier eine inoffizielle Übersetzung) jedoch mit Prefix KKWiki in Form KKWiki - Hilfe:Vorlagen als neue, modifizierte Version anzusehen.

Das Original (transparente Kopie) ist unter dem obersten Wikipedialink gemäß Lizenz bzw. auf der Wikipedia üblichen Gentlemen Agreement verfügbar. Eine Möglichkeit zur Sichtung besteht bei Änderungen vielleicht hier im Internetarchive "Waybackmachine". Sollten viele Links ins Leere führen, so suche die evtl. Versionsgeschichte mit den Autoren da mit Vorsilbe:Wikipedia oder vielleicht auch da ohne Vorsilbe in der Wikipedia, eventuell wurde diese Version zwischenzeitlich umbenannt, gelöscht oder anderweitig ausgelagert, darauf haben wir keinen Einfluss, sind aber verpflichtet dem nachzugehen. Spreche bitte daraufhin einen der hiesigen Administratoren an, er wird dir die neue Seite mit den Autoren raussuchen und nötigenfalls einen korrekten Einzel-Link zur Ursprungsversion (wenn verfügbar) setzen.

Zur Nutzung dieses Artikels lese extern Wikipedia GNU Free Documentation License bzw. die lokale Kopie der GNU-Lizenz für freie Dokumentation GFDL lokale Kopie oder ergänzend die unter der Lizenzseite aufgeführten, Bilder und sonstige Texte berührenden Lizenzen. Bei Fragen zum Copyright oder Urheber wenden sie sich bitte an die Autoren bzw. einen Administrator!