20.323
Bearbeitungen
Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Vorlage:Dokumentation/Doku (Quelltext anzeigen)
Version vom 9. Januar 2012, 20:39 Uhr
, 9. Januar 2012→Unterseiten
Admin (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}} </noinclude>Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text vo…“) |
Admin (Diskussion | Beiträge) K (→Unterseiten) |
||
| (2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 5: | Zeile 5: | ||
== 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 ''„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. | 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 noinclude-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien|Kategorien]] und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload). | |||
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-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien|Kategorien]] und | |||
In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher | In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher | ||
| Zeile 28: | Zeile 26: | ||
; <code>/Meta</code> | ; <code>/Meta</code> | ||
: Eine solche Unterseite ist vor allem für [[ | : Eine solche Unterseite ist vor allem für [[Helmstedt-Wiki:Geschützte Seiten|vollgesperrte Seiten]] gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf. | ||
; <code>/XML</code> | ; <code>/XML</code> | ||
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[ | : Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Helmstedt-Wiki:Helferlein/Vorlagen-Meister|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben. | ||
; <code>/Wartung</code> | ; <code>/Wartung</code> | ||
: Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben. | : Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben. | ||
| Zeile 36: | Zeile 34: | ||
: Ein Hinweis wird auch für Testunterseiten ausgegeben. | : Ein Hinweis wird auch für Testunterseiten ausgegeben. | ||
; <code>/Druck</code> | ; <code>/Druck</code> | ||
: Eine spezielle Version der Vorlage, die zusammen mit der | : Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird. | ||
; <code>/Editnotice</code> | ; <code>/Editnotice</code> | ||
: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird. | : Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird. | ||