Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Aus WiiDatabase Wiki
Zur Navigation springenZur Suche springen
ICON (Diskussion | Beiträge) K (Textersetzung - „{{Geschützt}}“ durch „“) |
ICON (Diskussion | Beiträge) KKeine Bearbeitungszusammenfassung |
||
| Zeile 1: | Zeile 1: | ||
<noinclude>{{Dokumentation/Dokuseite}}</noinclude> | <noinclude>{{Dokumentation/Dokuseite}}</noinclude> | ||
Diese [[ | Diese [[w:Hilfe:Vorlagen|Vorlage]] zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein. | ||
== Begründung == | == Begründung == | ||
| Zeile 10: | Zeile 10: | ||
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. 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- | </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 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 | In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher | ||
| Zeile 22: | Zeile 22: | ||
== Besonderheiten == | == Besonderheiten == | ||
Wenn sich die Vorlage im [[ | Wenn sich die Vorlage im [[w: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 | : Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf. | ||
; <code>/XML</code> | ; <code>/XML</code> | ||
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben. | : Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben. | ||
; <code>/Wartung</code> | ; <code>/Wartung</code> | ||
: Sollte es eine [[ | : Sollte es eine [[w:Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben. | ||
; <code>/Test</code> | ; <code>/Test</code> | ||
: Ein Hinweis wird auch für Testunterseiten ausgegeben. | : Ein Hinweis wird auch für Testunterseiten ausgegeben. | ||
; <code>/Editnotice</code> | ; <code>/Editnotice</code> | ||
: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird. | : Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird. | ||
Version vom 25. März 2018, 22:18 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.
/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.
