Vorlage:Dokumentation/Doku
Aus Kitakien
| Zeile 4: | Zeile 4: | ||
Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclide></code> an den Anfang einer Vorlage schreibst und die entsprechende Dokumentationsseite erstellst. Diese sollte in einem <code><includeonly></code>-Abschnitt auch die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die Kategorieren und Interwikilinks. | Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclide></code> an den Anfang einer Vorlage schreibst und die entsprechende Dokumentationsseite erstellst. Diese sollte in einem <code><includeonly></code>-Abschnitt auch die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die Kategorieren und Interwikilinks. | ||
| + | |||
| + | == Besonderheiten == | ||
| + | |||
| + | Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung (Unterseite ''<code>/XML</code>'') für den [[Benutzer:Revvar/VM|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben (→ [[Vorlage:XML-Hinweis|XML-Hinweis]]). Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] (Unterseite ''<code>/Wartung</code>'') für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ [[Vorlage:Wartungshinweis|Wartungshinweis]]). | ||
<includeonly> | <includeonly> | ||
[[Kategorie:Vorlage:für Vorlagen|Dokumentation]] | [[Kategorie:Vorlage:für Vorlagen|Dokumentation]] | ||
Version vom 09:06, 8. Nov. 2007
Diese Vorlage zeigt automitsch eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/doc]] ein. Diese Vorlage solle bei allen Vorlagen Verwendung finden; die Beschreibung sollte immer aus der eigentlichen Vorlage ausgelagert werden.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <noinclude>{{Dokumentation}}</noinclide> an den Anfang einer Vorlage schreibst und die entsprechende Dokumentationsseite erstellst. Diese sollte in einem <includeonly>-Abschnitt auch die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die Kategorieren und Interwikilinks.
Besonderheiten
Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung (Unterseite /XML) für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis). Sollte es eine Wartungsseite (Unterseite /Wartung) für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).en:Template:Documentation/doc
