Vorlage:Z-doku

Die hier beschriebene Methodik ist obsolet und nicht mehr anzuwenden.

Zweck

Es gibt zahlreiche Vorlagen in der Wikipedia, die mit subst: eingebunden werden sollen und in den meisten Fällen eingebunden werden, sodass also der Quelltext der Vorlage auf die Seite gesetzt wird, als ob man ihn direkt dort hingeschrieben hätte. Werden Vorlagen mit subst: eingefügt, gibt es keine direkte Verbindung mehr zur Vorlagenseite, von der der Quelltext stammt, außer wenn eine auskommentierte Notiz die Herkunft des Textes verrät, wie z. B. <!-- Vorlage:Name -->.

Solcher auskommentierter Text war in früheren Zeiten nicht suchbar. Heutzutage ist das aber mittels insource-Suche problemlos möglich und absolutes Mittel der Wahl.

Daher war es früher in den meisten Fällen unmöglich, auf konsistente und einfache Weise die Verwendung einer Vorlage zurückzuverfolgen, die normalerweise mit subst: eingebunden wird. Im Gegensatz dazu werden Vorlagen, die ohne subst: eingebunden werden mit ihrer dazugehörigen Vorlagenseite verbunden und alles was man tun muss, wenn man die Verwendung der Vorlage überprüfen will, ist die Linkliste auf die Vorlagenseite zu überprüfen, wo auch die Einbindungen aufgeführt sind.

Die z-Vorlagen, angefangen mit {{z1}} und aufsteigend ({{z2}}, {{z3}}, {{z4}} etc.) sind leere, niemals mit subst: eingebundene Vorlagen, deren einziger Zweck es ist, einen Nachverfolgungsmechanismus in anderen Vorlagen zur Verfügung zu stellen, die mit subst: eingebunden sind. Jede z-Vorlage wird in einer bestimmten, normalerweise mit subst: eingebundenen Vorlage eingebaut, wo die Rückverfolgung der Verwendung nötig ist. Das ermöglicht die Rückverfolgung der Verwendung der eingebundenen Vorlage, indem man überprüft, welche Seiten zur verwendeten z-Vorlage mit der entsprechenden Nummer verlinken, ohne dass die Vorlage selbst oder ihre Arbeitsweise irgendwie davon beeinflusst wird. Diese kleinen z-Vorlagen werden einfach in den Quelltext der vorhandenen Vorlage eingebaut und bleiben dann in der Vorlage unsichtbar, wenn man nicht den Quelltext anschaut. Durch die Einbindung der Vorlage wird kein sichtbares Material mit eingebunden, da die z-Vorlagen selbst keinen Quelltext enthalten.

Erstellung und Verwendung

Um z-Vorlagen zu verwenden, musst du:

1. Eine spezifische z-Vorlage erstellen, die eineindeutig mit einer vorhandenen Vorlage assoziiert ist. Dafür musst du in der Liste der zugewiesenen z-Vorlagen unten die höchste zugewiesene Nummer suchen und eine neue z-Vorlage mit der nächsthöheren Nummer anlegen. Wenn also z. B. z1 bis z83 bereits verwendet werden, legst du die Vorlage:z84 an. Alle z-Vorlagen erhalten den gleichen Inhalt. Kopiere den folgenden Text in die z-Vorlage, die du erstellst, klicke auf speichern und du hast die Vorlage erstellt: <noinclude>{{Z-doku}}</noinclude> (ja, das ist alles);
2. Füge die z-Vorlage, die du erstellt hast, zur Liste der zugewiesenen z-Vorlagen unten auf dieser Seite hinzu, und assoziiere sie mit der Vorlage, in die du sie einbauen willst, um ihre Verwendung zurückzuverfolgen;
3. Gehe zur normalerweise mit subst: eingebundenen Vorlage, die zu zurückverfolgen willst, und füge irgendwo die z-Vorlage in normaler Einbindung, ohne subst:, ein. Wir empfehlen, die z-Vorlage ganz am Ende des Quelltexts einzufügen, zusammen mit dem auskommentierten Namen der Vorlage, also z. B. {{z84}}<!-- Vorlage:Name -->;
4. Stelle sicher, dass die z-Vorlage niemals innerhalb von Parserfunktionen im Vorlagenquelltext eingebunden werden, wie z. B. einer #if-Funktion oder anderen Bedingungsfunktionen, damit sie unabhängig von jeder Parameterbelegung stets eingebunden wird;
5. Falls die Vorlage, die du zurückverfolgen möchtest, für das Bearbeiten gesperrt ist, beantrage das Einfügen der z-Vorlage auf WP:AA.

Rückverfolgung

Wenn du erst einmal die z-Vorlage erstellt und einer normalerweise mit subst: eingefügten Vorlage zugewiesen hast, gehe einfach auf die Seite der z-Vorlage und klicke „Links a. d. Seite“ im Menü links unten unter „Werkzeuge“, und alle Seiten, die dort aufgelistet sind, außer die anderen z-Vorlagen, sind die, in denen die zugewiesene Vorlage eingebunden wurde.

Liste der zugewiesenen z-Vorlagen

{{Z1}} → {{Willkommen-rand/default}}
{{Z2}} → {{Willkommen-rand/wenigerlinks}}
{{Z3}} → {{Willkommen-rand/kurz}}