Vorlage:Documentation
Vorlagendokumentation
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.
Meine Vorlagendoku zeigt in der Vorlagenseite den Wikitext an, der die Vorlage erzeugt, 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 Vorlagendokumentation 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. Alles, was du tun musst, ist die doc-Unterseite über den angebotenen Link erstellen, damit die Vorlage/preload-doc beim Anlegen benutzt wird (an dieser Seite habe ich eine ganze Weile getüftelt, bis sie genau das tut, was ich will; es ist durchaus möglich, dass ich weitere Verbesserungen vornehmen werde). Den Text für die Dokumentation musst du natürlich selbst eintippen, den kann mein Programm nicht vorhersagen. 
{{!}}
{{{!}} {{!}} 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 Vorlage:Documentation/doc, wenn sie existiert •
dieser Text dient als Orientierungshilfe und wird nicht eingebunden
Beginn der Dokumentationsunterseite Vorlage:Documentation/docDie Vorlage {{Documentation}} 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
{{Documentation}}
Code
{{bearbeiten}}<onlyinclude>{{Documentation/ruler}}
{{Documentation/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.
----
{{klappbox|Was kann meine Vorlagendokumentation, was die anderen nicht können?|2=Meine Vorlagendoku zeigt in der Vorlagenseite den Wikitext an, der die Vorlage erzeugt, 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 Vorlagendokumentation 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. Alles, was du tun musst, ist die doc-Unterseite über den angebotenen Link erstellen, damit die Vorlage <code>/preload-doc</code> beim Anlegen benutzt wird (an dieser Seite habe ich eine ganze Weile getüftelt, bis sie genau das tut, was ich will; es ist durchaus möglich, dass ich weitere Verbesserungen vornehmen werde). Den Text für die Dokumentation musst du natürlich selbst eintippen, den kann mein Programm nicht vorhersagen. [[File:Winking-smiley.svg|20px]]|breit=95%}}
----
{{klappbox|1=Pipe-Zeichen {{!}} und magisches Wort <code><nowiki>{{!}}</nowiki></code>|2=<code><nowiki>{{{!}}</nowiki> <code><nowiki>{{!}}</nowiki></code> ist ein [https://www.mediawiki.org/wiki/Help:Magic_words/de#Other magisches Wort] und erzeugt das Pipe-Zeichen {{!}} (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 {{{!}} umgewandelt wird und somit eine Tabellezeile erzeugt.|breit=95%}}
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>
{{Documentation/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;">[[{{fullurl:{{SUBJECTPAGENAME}}/doc|action=edit}} Bearbeiten]]</span>.</li>
<li>[[Special:PrefixIndex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li>
</ul>
{{!}}}
|
{{Documentation/nodoc}}
}}</onlyinclude>
<div style="border-bottom: thick double blue;border-top: thick double blue;">
== Wenn die Unterseite /doc nicht vorhanden ist ==
{{Documentation/nodoc}}
</div>
__NOTOC__Parameter
- keine
- Verwendungen dieser Vorlage
- Diese Dokumentation befindet sich auf einer eingebundenen Unterseite [Bearbeiten].
- Liste der Unterseiten.
Wenn die Unterseite /doc nicht vorhanden ist
Du hast die Vorlagendokumentation mit dem Befehl {{documentation}} eingebunden
Damit die Dokumentation wie vorgesehen funktioniert, ist es erforderlich, dass du für deine Vorlage {{Documentation}} die Unterseite Vorlage:Documentation/doc anlegst, das kannst du mit der Box unter diesem Text durchführen.
Unterseite Vorlage:Documentation/doc erstellen
Eine Liste der bereits vorhandenen Unterseiten (für den Fall, dass die Dokuseite schon existiert und bloß falsch benannt wurde):