Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Vorlage:Dokumentation/Doku (Quelltext anzeigen)
Version vom 7. September 2012, 14:04 Uhr
, 7. September 2012typo, Vorlage für lokalisierte Anführungszeichen
(,) |
wp>Geitost K (typo, Vorlage für lokalisierte Anführungszeichen) |
||
Zeile 6: | Zeile 6: | ||
== Begründung == | == 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 <code><noinclude></code>s vor den tatsächlichen Einbindungen ausgewertet, so dass man die '' | 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 <code><noinclude></code>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 == | == Benutzung == | ||
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Eine Unterseite namens <code>/Meta</code> kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt [[#Besonderheiten|Besonderheiten]] lesen), ansonsten können diese mit in die | Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Eine Unterseite namens <code>/Meta</code> kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt [[#Besonderheiten|Besonderheiten]] lesen), ansonsten können diese mit in die Noinclude-[[Tag (Informatik)|Tags]] am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikilinks]]. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt ''(preload).'' | ||
In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher | In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher |