Vorlage:Dokumentation
Image:Information icon.svg{{#if:18px||18px}}|Informationen zu dieser Dokumentation {{#if:#Dokumentation.Info
|
default {{#switch: {{#switch:|={{#titleparts:#Dokumentation.Info|1|1}}|0=|Http:}}
|Http:|Https:|Ftp:|Ftps: = [#Dokumentation.Info Informationen zu dieser Dokumentation] |#default = Informationen zu dieser Dokumentation }}
desc keine
|{{#if: | |default Datei:Information icon.svg
desc keine }}}}
</imagemap>{{#if:|{{#ifexist: Vorlage:Dokumentation/Doku|
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]]
ein.
Diese Vorlage sollte bei allen Vorlagen verwendet werden.
Inhaltsverzeichnis
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher und entlastet vor allem den Parser: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt ohnehin wieder weggelassen wird. Trotzdem werden <noinclude>
s vor den tatsächlichen Einbindungen ausgewertet, so dass man die „Pre-expand include size“ drastisch drücken kann, wenn man die Dokumentationen in Unterseiten schreibt. Daher sollte die Beschreibung immer aus der eigentlichen Vorlage ausgelagert werden. Somit ermöglicht man die Nutzung von mehr Vorlagen pro Artikelseite.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude>
ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]]
erstellt. Eine Unterseite namens /Meta
kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt Besonderheiten lesen), ansonsten können diese mit in die noinclude-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).
In den Unterseiten stellen folgende Codezeilen den Rückbezug sicher
- /Doku
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
- /Meta
<noinclude>{{Dokumentation/Metaseite}}</noinclude><includeonly> … Meta … </includeonly>
- /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>
- /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>
Besonderheiten
Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage, noch die Unterseite, werden in Kategorien einsortiert.
Unterseiten
-
/Meta
- Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten.
-
/XML
- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis).
-
/Wartung
- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).
-
/Test
- Ein Hinweis wird auch für Testunterseiten ausgegeben.
Unterseiten anlegen
<inputbox> type=create default=Vorlage:<Name der Vorlage>/Doku buttonlabel=Dokumentationsseite anlegen preload=Vorlage:Dokumentation/preload-doku editintro=Vorlage:Dokumentation/intro-doku bgcolor=#eeeeff break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Meta buttonlabel=Metadatenseite anlegen preload=Vorlage:Dokumentation/preload-meta editintro=Vorlage:Dokumentation/intro-meta bgcolor=#eeeeff break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Test buttonlabel=Test- und Beispielseite anlegen preload=Vorlage:Dokumentation/preload-test editintro=Vorlage:Dokumentation/intro-test bgcolor=#eeeeff break=no </inputbox> |
Information |
• Verwendung der Vorlage in Artikeln.
• Diese Dokumentation wird von einer Unterseite eingebunden. {{#ifexist:Vorlage:Dokumentation/Wartung|
• Für diese Vorlage existiert eine Wartungsseite zum Auffinden fehlerhafter Verwendungen. |
}}{{#ifexist:Vorlage:Dokumentation/XML| • Für diese Vorlage existiert eine XML-Beschreibung für den Vorlagenmeister.
}}{{#ifexist:Vorlage:Dokumentation/Test| • Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der Testseite. |
}}{{#ifexist: Vorlage:Dokumentation/Meta| • Die Metadaten (Kategorien und Interwikis) {{#ifeq:Vorlage|Benutzer
|
in Vorlage:Dokumentation/Meta werden nicht eingebunden, weil sich die Vorlage im Benutzernamensraum befindet | werden von einer Unterseite eingebunden}}. |
}}
|
|
{{#ifexist:Vorlage:Dokumentation/Meta||
{{#ifexist:Vorlage:Dokumentation/Test||
{{#ifexist:Vorlage:Dokumentation/Wartung||
}}
</div>{{#ifeq:Vorlage|Benutzer||{{#ifexist: Vorlage:Dokumentation/Meta|ca:Plantilla:Ús de la plantilla da:Skabelon:Dokumentation dsb:Pśedłoga:Dokumentacija en:Template:Documentation eo:Ŝablono:Dok es:Plantilla:Documentación de plantilla et:Mall:Usage of template fa:الگو:توضیحات fr:Modèle:Documentation modèle gl:Modelo:Uso de marcador hsb:Předłoha:Doc hu:Sablon:Sablondokumentáció ja:Template:Documentation ko:틀:틀 설명문서 nl:Sjabloon:Sjabdoc pl:Szablon:Dokumentacja pt:Predefinição:Instruções da predefinição ru:Шаблон:Doc sl:Predloga:Dokumentacija uk:Шаблон:Doc zh:Template:Documentation }}}}
}}