Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Mordan (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Mordan (Diskussion | Beiträge) |
||
Zeile 9: | Zeile 9: | ||
== Benutzung == | == Benutzung == | ||
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}} | 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. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).'' | ||
In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher | In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher |
Aktuelle Version vom 10. Dezember 2015, 13:57 Uhr
Vorlage:Dokumentation/Dokuseite
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]]
ein.
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude>
ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]]
erstellt. Nach dem Generieren der Dokumentation werden 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>
- Hinweis: Diese Methode ist veraltet und wird zurückgebaut (integriert in /Doku).
- /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>
- /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>
- /Editnotice
<noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>
- /Unterseite
<noinclude>{{Dokumentation/Unterseite}}</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 war vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht kategorisiert werden konnten, und sie sollte Interwiki-Bots das Beschreiben ermöglichen, ohne durch Halbschutz blockiert zu werden und auf den Beobachtungslisten nicht stören. Diese Unterseite nahm auch Kategorisierungen auf.
- Interwiki-Links befinden sich inzwischen auf Wikidata.
- Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in
<includeonly>
eingeschlossen am Ende von/Doku
eingefügt werden. - Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände werden aufgelöst.
- Siehe Hilfe:Vorlagendokumentation #Meta-Daten.
/XML
- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
/Wartung
- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
/Test
- Ein Hinweis wird auch für Testunterseiten ausgegeben.
/Editnotice
- Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.
Unterseiten anlegen
Wenn man das MediaWiki:Gadget-Personendaten in den Einstellungen aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.
Weitere Informationen