Template:Vorlagendokumentation

---

Template:Vorlagendokumentation/layout Ich habe die Vorlagen Vorlagendokumentation auf Commons, in der englischen und in der deutschen Wikipedia kombiniert, Teile entfernt, die ich nicht benötige, um die Übersichtlichkeit zu verbessern und das Verständnis zu erleichtern

Was kann meine Vorlagendokumentation, was die anderen nicht können? Meine Vorlagendoku zeigt in der Vorlagenseite den Wikitext an, wobei der Text direkt aus der Vorlage eingebunden wird. Das bedeutet, dass sich die Dokumentation automatisch aktualisiert, wenn die Vorlage geändert wird. Sobald die Vorlagendokumentation in eine Vorlage eingebunden wird, wirst du darauf hingewiesen, dass eine Unterseite /doc erforderlich ist. Dieser Name ist fest vorgegeben, da ich den Aufwand für eine Variationsmöglichkeit (derzeit) nicht treiben und die Vorlage so einfach wie möglich gestalten wollte.

Weiters wird wenn möglich ein Anwendungsbeispiel eingebunden, sodass du nach der Änderung der Vorlage sofort die Auswirkung siehst, ohne die Seite verlassen zu müssen.

{{!}} ist ein magisches Wort und erzeugt das Pipe-Zeichen | (der senkrechte Strich, der in der MediaWiki-Syntax ständig benötigt wird)

Die Zeichenfolge {{{!}} darf nicht getrennt werden, weil dies zu {| umgewandelt wird und somit eine Tabellezeile erzeugt.

Einbinden der Dokumentationsunterseite Template:Vorlagendokumentation/doc, wenn sie existiert • dieser Text dient als Orientierungshilfe und wird nicht eingebunden

Beginn der Dokumentationsunterseite Template:Vorlagendokumentation/doc

Die Vorlage {{Vorlagendokumentation}} zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/doc]] ein.

Begründung

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.

• Insbesondere führt eine kleine Änderung in der Dokumentation nicht dazu, dass Tausende einbindender Seiten neu generiert werden müssen.
• In der Versionsgeschichte der Programmierungsseite erscheinen nur noch Änderungen, die die wirksamen Einbindungen betreffen.

Verwendung

{{Vorlagendokumentation}}

Code

[[Category:Template documentation]] <onlyinclude>{{Vorlagendokumentation/ruler}} {{Vorlagendokumentation/layout}} <noinclude>Ich habe die Vorlagen [[Template:Documentation|Vorlagendokumentation auf Commons]], [[:en:Template:Documentation|in der englischen]] und [[:de:Template:Dokumentation|in der deutschen Wikipedia]] kombiniert, Teile entfernt, die ich nicht benötige, um die Übersichtlichkeit zu verbessern und das Verständnis zu erleichtern Was kann meine Vorlagendokumentation, was die anderen nicht können? Meine Vorlagendoku zeigt in der Vorlagenseite den Wikitext an, wobei der Text direkt aus der Vorlage eingebunden wird. Das bedeutet, dass sich die Dokumentation ''automatisch aktualisiert'', wenn die Vorlage geändert wird. Sobald die Vorlagendokumentation in eine Vorlage eingebunden wird, wirst du darauf hingewiesen, dass eine Unterseite '''/doc''' erforderlich ist. Dieser Name ist fest vorgegeben, da ich den Aufwand für eine Variationsmöglichkeit (derzeit) nicht treiben und die Vorlage so einfach wie möglich gestalten wollte. Weiters wird wenn möglich ein Anwendungsbeispiel eingebunden, sodass du nach der Änderung der Vorlage sofort die Auswirkung siehst, ohne die Seite verlassen zu müssen. <code><nowiki>{{!}}</nowiki></code> ist ein [https://www.mediawiki.org/wiki/Help:Magic_words/de#Other magisches Wort] und erzeugt das Pipe-Zeichen <nowiki>|</nowiki> (der senkrechte Strich, der in der MediaWiki-Syntax ständig benötigt wird) Die Zeichenfolge <code><nowiki>{{{!}}</nowiki></code> darf nicht getrennt werden, weil dies zu <nowiki>{|</nowiki> umgewandelt wird und somit eine Tabellezeile erzeugt. Einbinden der Dokumentationsunterseite [[{{SUBJECTPAGENAME}}/doc]], wenn sie existiert • dieser Text dient als Orientierungshilfe und wird nicht eingebunden</noinclude> {{#ifexist: {{SUBJECTPAGENAME}}/doc| <noinclude><div style="margin-top:1em; clear: both; border: 2px dotted #666666; padding: 0.6em; background-color: #ccffff; text-align: center; ">Beginn der Dokumentationsunterseite [[{{SUBJECTPAGENAME}}/doc]]</div></noinclude> {{ {{SUBJECTPAGENAME}}/doc}} <noinclude><div class="messagebox" style="margin-top:1em; clear: both; border: 2px dotted #666666; padding: 0.6em; background-color: #ccffff; text-align: center; ">Ende der Dokumentationsunterseite [[{{SUBJECTPAGENAME}}/doc]]</div></noinclude> {{Vorlagendokumentation/ruler}} {{{!}} class="plainlinks" id="Dokumentation.Info" style="border-collapse:collapse; margin:2px 0;" {{!}} class="noviewer" style="padding:5px; vertical-align:top; width:40px;" {{!}} [[File:Information icon.svg|30px]] {{!}} style="padding:0; width:100%;" {{!}} <ul> <li>[{{fullurl:Special:WhatLinksHere/{{FULLPAGENAME}}|hideredirs=1&hidelinks=1}} Verwendungen] dieser Vorlage</li> <li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/doc|auf einer eingebundenen Unterseite]] <span style="font-size:85%; margin-left:1em;">&#91;[{{fullurl:{{SUBJECTPAGENAME}}/doc|action=edit}} Bearbeiten]&#93;</span>.</li> {{#ifexist:{{SUBJECTPAGENAME}}/Wartung | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] <span style="font-size:85%;">&#91;[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit}} Bearbeiten]&#93;</span> zum Auffinden fehlerhafter Verwendungen.</li> }}{{#ifexist:{{SUBJECTPAGENAME}}/XML | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] <span style="font-size:85%;">&#91;[{{fullurl:{{SUBJECTPAGENAME}}/XML|action=edit}} Bearbeiten]&#93;</span> für den [[Wikipedia:Technik/Skin/Gadgets/Vorlagenmeister|Vorlagenmeister]].</li> }}{{#ifexist:{{SUBJECTPAGENAME}}/Test | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]] <span style="font-size:85%; margin-left:1em;">&#91;[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit}} Bearbeiten]&#93;</span>.</li> | <li>[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Template:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li> }}{{#ifexist:{{SUBJECTPAGENAME}}/Editnotice | <li>Es existiert ein [[{{SUBJECTPAGENAME}}/Editnotice|Bearbeitungshinweis]] <span style="font-size:85%;">&#91;[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit}} Bearbeiten]&#93;</span>, der beim Bearbeiten der Vorlage angezeigt wird.</li> }} <li>[[Special:PrefixIndex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li> </ul> {{!}}} | {{Vorlagendokumentation/nodoc}} }}</onlyinclude> Und so schaut es aus, wenn keine doc-Unterseite vorhanden ist: [[Template:Vorlagendokumentation/nodoc]]

Parameter

keine

Ende der Dokumentationsunterseite Template:Vorlagendokumentation/doc

---

Verwendungen dieser Vorlage Diese Dokumentation befindet sich auf einer eingebundenen Unterseite [Bearbeiten]. Test-/Beispielseite erstellen. Liste der Unterseiten.

Und so schaut es aus, wenn keine doc-Unterseite vorhanden ist: Template:Vorlagendokumentation/nodoc