Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
wp>Crissov (→Unterseiten: /Meta Interwiki-Links befinden sich inzwischen auf Wikidata.) |
wp>Antonsusi Keine Bearbeitungszusammenfassung |
||
| Zeile 5: | Zeile 5: | ||
== Begründung == | == Begründung == | ||
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher. | Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher. | ||
== Benutzung == | == Benutzung == | ||
Diese Vorlage hat einen optionalen Parameter "nr". Hier kann die Nummer eines Namesraums angegeben werden, in dem die Verwendung der Vorlage angefragt wird. Genaueres siehe Parameter ns der [[Vorlage:Verwendung]]. Möglich ist die Angabe von 0 (Artikel), 2 (Benutzer), 4 (Systemseiten), 6 (Dateien),10 (Vorlagen), 14 (Kategorien), 100 (Portal) und leer ("nr="; für alle Seiten). Vorgabewert ist "0". | |||
Diese Vorlage | Es reicht also auch, 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 | ||
| Zeile 22: | Zeile 21: | ||
== Besonderheiten == | == Besonderheiten == | ||
Wenn sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite werden in Kategorien einsortiert. | Wenn sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite werden in Kategorien einsortiert. | ||
=== Unterseiten === | === Unterseiten === | ||
; <code>/Meta</code> | ; <code>/Meta</code> | ||
: Eine solche Unterseite ist vor allem für [[Wikipedia:Geschützte Seiten|vollgesperrte Seiten]] gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf. Interwiki-Links befinden sich inzwischen auf Wikidata. | : Eine solche Unterseite ist vor allem für [[Wikipedia:Geschützte Seiten|vollgesperrte Seiten]] gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf. Interwiki-Links befinden sich inzwischen auf Wikidata. | ||
Version vom 5. September 2013, 22:21 Uhr
|
Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation. |
|
Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Meist ist es jedoch sinnvoll, Änderungswünsche erst auf Vorlage Diskussion:Dokumentation abzustimmen. |
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 hat einen optionalen Parameter "nr". Hier kann die Nummer eines Namesraums angegeben werden, in dem die Verwendung der Vorlage angefragt wird. Genaueres siehe Parameter ns der Vorlage:Verwendung. Möglich ist die Angabe von 0 (Artikel), 2 (Benutzer), 4 (Systemseiten), 6 (Dateien),10 (Vorlagen), 14 (Kategorien), 100 (Portal) und leer ("nr="; für alle Seiten). Vorgabewert ist "0".
Es reicht also auch, wenn man <noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] 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> - /Druck
<noinclude>{{Dokumentation/Druckversion}}</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 ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf. Interwiki-Links befinden sich inzwischen auf Wikidata.
/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.
/Druck- Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
/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.