Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
ICON (Diskussion | Beiträge) KKeine Bearbeitungszusammenfassung |
ICON (Diskussion | Beiträge) K (→Besonderheiten) |
||
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| Zeile 28: | Zeile 28: | ||
; <code>/Meta</code> | ; <code>/Meta</code> | ||
: Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf. | : Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf. | ||
; <code>/Wartung</code> | ; <code>/Wartung</code> | ||
: Sollte es eine [[w:Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben. | : Sollte es eine [[w:Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben. | ||
| Zeile 36: | Zeile 34: | ||
; <code>/Editnotice</code> | ; <code>/Editnotice</code> | ||
: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird. | : Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird. | ||
== Unterseiten anlegen == | |||
{| class="wikitable" style="background:#EEEEFF; margin:2px auto;" | |||
|- | |||
| | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Doku | |||
buttonlabel=Dokumentationsseite anlegen | |||
preload=Vorlage:Dokumentation/preload-doku | |||
editintro=Vorlage:Dokumentation/intro-doku | |||
break=no | |||
width=35 | |||
</inputbox> | |||
|- | |||
| | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Test | |||
buttonlabel=Test- und Beispielseite anlegen | |||
preload=Vorlage:Dokumentation/preload-test | |||
editintro=Vorlage:Dokumentation/intro-test | |||
break=no | |||
width=33 | |||
</inputbox> | |||
|- | |||
| | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Editnotice | |||
buttonlabel=Editnotice anlegen | |||
preload=Vorlage:Dokumentation/preload-editnotice | |||
editintro=Vorlage:Dokumentation/intro-editnotice | |||
break=no | |||
width=47 | |||
</inputbox> | |||
|} | |||
Aktuelle Version vom 15. Juni 2018, 12:19 Uhr
|
Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation. |
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. 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-Tag 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>- /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.
/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.
