Vorlage:Dokumentation: Unterschied zwischen den Versionen

Aus KKWiki
Zur Navigation springenZur Suche springen
K (r2.6.4) (Bot: Ergänze: als, ar, ba, bar, bg, bs, ca, ckb, cs, cy, da, diq, dsb, el, en, eo, es, et, eu, fa, fr, gl, he, hsb, hu, hy, ia, id, it, ja, ko, ku, la, ltg, ml, nds-nl, nl, no, nso, pl, pt, ro, ru, simple, sk, sl, sq, sr, stq, sv, sw, te...)
K (Änderung 96071873 von CarsracBot wurde rückgängig gemacht. Nach /Meta geschoben)
Zeile 80: Zeile 80:
 
{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
 
{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
 
}}}}
 
}}}}
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0em; height:0.7ex;" /></onlyinclude><noinclude>
+
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0em; height:0.7ex;" /></onlyinclude>
[[als:Vorlage:Dokumentation]]
 
[[ar:قالب:توثيق]]
 
[[ba:Ҡалып:Doc]]
 
[[bar:Vorlage:Dokumentation]]
 
[[bg:Шаблон:Документация]]
 
[[bs:Šablon:Dokumentacija]]
 
[[ca:Plantilla:Ús de la plantilla]]
 
[[ckb:داڕێژە:Documentation]]
 
[[cs:Šablona:Dokumentace]]
 
[[cy:Nodyn:Doc]]
 
[[da:Skabelon:Dokumentation]]
 
[[diq:Template:Documentation]]
 
[[dsb:Pśedłoga:Dokumentacija]]
 
[[el:Πρότυπο:Τεκμηρίωση προτύπου]]
 
[[en:Template:Documentation]]
 
[[eo:Ŝablono:Dok]]
 
[[es:Plantilla:Documentación]]
 
[[et:Mall:Dokumentatsioon]]
 
[[eu:Txantiloi:Txantiloi dokumentazioa]]
 
[[fa:الگو:توضیحات]]
 
[[fr:Modèle:Documentation]]
 
[[gl:Modelo:Uso de marcador]]
 
[[he:תבנית:תיעוד]]
 
[[hsb:Předłoha:Dokumentacija]]
 
[[hu:Sablon:Sablondokumentáció]]
 
[[hy:Կաղապար:Փաստաթղթեր]]
 
[[ia:Patrono:Documentation]]
 
[[id:Templat:Dokumentasi]]
 
[[it:Template:Man]]
 
[[ja:Template:Documentation]]
 
[[ko:틀:틀 설명문서]]
 
[[ku:Şablon:Belgekirin]]
 
[[la:Formula:Documentation]]
 
[[ltg:Taiss:Dokumentaceja]]
 
[[ml:ഫലകം:വിവരണം]]
 
[[nds-nl:Mal:Dokumentatie]]
 
[[nl:Sjabloon:Sjabdoc]]
 
[[no:Mal:Dokumentasjon]]
 
[[nso:Template:Documentation]]
 
[[pl:Szablon:Dokumentacja]]
 
[[pt:Predefinição:Documentação]]
 
[[ro:Format:Documentație]]
 
[[ru:Шаблон:Doc]]
 
[[simple:Template:Documentation]]
 
[[sk:Šablóna:Dokumentácia]]
 
[[sl:Predloga:Dokumentacija]]
 
[[sq:Stampa:Dokumentacion]]
 
[[sr:Шаблон:Документација]]
 
[[stq:Foarloage:Dokumentation]]
 
[[sv:Mall:Dokumentation]]
 
[[sw:Kigezo:Documentation]]
 
[[te:మూస:Documentation]]
 
[[tl:Suleras:Documentation]]
 
[[tpi:Template:Template doc]]
 
[[tr:Şablon:Belgeleme]]
 
[[tt:Калып:Doc]]
 
[[uk:Шаблон:Документація]]
 
[[ur:سانچہ:Documentation]]
 
[[war:Template:Documentation]]
 
[[yo:Àdàkọ:Aṣàlàyé]]
 
[[zh:Template:Documentation]]
 
</noinclude>
 

Version vom 16. November 2011, 19:16 Uhr


<span style="visibility:hidden" id="[Bearbeiten] Dokumentation"><span id="Anker:[Bearbeiten] Dokumentation">[Bearbeiten] Dokumentation

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 Verwendung finden.

Begründung

Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.

Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh 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 entsprechende Dokumentationsseite 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 vorallem 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



Bei Fragen zu dieser Vorlage kannst Du Dich an die Vorlagenwerkstatt wenden.