Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen

keine Bearbeitungszusammenfassung
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 erwartet keine Parameter. Es reicht, wenn man <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/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).''
Es reicht also auch, wenn man <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/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.
Anonymer Benutzer