Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „Test - erst“) |
K (1 Version) |
||
(Eine dazwischenliegende Version von einem anderen Benutzer wird nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
Test - | <noinclude>{{Dokumentation/Dokuseite}}</noinclude> | ||
{{Tausendfach verwendet}} | |||
Diese [[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 == | |||
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher. | |||
== Benutzung == | |||
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 | |||
; /Doku | |||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki></noinclude></code> | |||
; /Meta | |||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki></noinclude><includeonly> … Meta … </includeonly></code> | |||
; /Test | |||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki></noinclude></code> | |||
; /Wartung | |||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki></noinclude></code> | |||
; /Editnotice | |||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Editnoticeseite|Dokumentation/Editnoticeseite]]<nowiki>}}</nowiki></noinclude></code> | |||
; /Unterseite | |||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Unterseite|Dokumentation/Unterseite]]<nowiki>}}</nowiki></noinclude></code> | |||
== 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. | |||
=== Unterseiten === | |||
; <code>/Meta</code> {{Anker|Meta-Unterseite}} | |||
: Seit der Verlegung der Interwiki-Verliinkungen auf [[Wikipedia:Wikidata|Wikidata]] dienen die Meta-Unterseiten nur noch den Kategorisierungen. | |||
; <code>/XML</code> | |||
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Wikipedia:Technik/Skin/Gadgets/Vorlagenmeister|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben. | |||
; <code>/Wartung</code> | |||
: Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben. | |||
; <code>/Test</code> | |||
: Ein Hinweis wird auch für Testunterseiten ausgegeben. | |||
; <code>/Editnotice</code> | |||
: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird. | |||
== Unterseiten anlegen == | |||
{| class="wikitable" style="background:#eef; 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 | |||
</inputbox> | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Meta | |||
buttonlabel=Metaseite anlegen | |||
preload=Vorlage:Dokumentation/preload-meta | |||
editintro=Vorlage:Dokumentation/intro-meta | |||
break=no | |||
</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 | |||
</inputbox> | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Wartung | |||
buttonlabel=Wartungsseite anlegen | |||
preload=Vorlage:Dokumentation/preload-wartung | |||
editintro=Vorlage:Dokumentation/intro-wartung | |||
break=no | |||
</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 | |||
</inputbox> | |||
|} | |||
Wenn man das [[MediaWiki:Gadget-Personendaten]] in den [[Spezial:Einstellungen|Einstellungen]] aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt. | |||
== Weitere Informationen == | |||
* [[Hilfe:Vorlagendokumentation]] | |||
<includeonly> | |||
[[Kategorie:Vorlage:für Vorlagen| ]] | |||
[[Kategorie:Vorlage:Metadokumentation| ]] | |||
</includeonly> |
Aktuelle Version vom 3. November 2015, 17:32 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 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>
- /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
- Seit der Verlegung der Interwiki-Verliinkungen auf Wikidata dienen die Meta-Unterseiten nur noch den Kategorisierungen.
/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
<inputbox> type=create default=Vorlage:<Name der Vorlage>/Doku buttonlabel=Dokumentationsseite anlegen preload=Vorlage:Dokumentation/preload-doku editintro=Vorlage:Dokumentation/intro-doku break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Meta buttonlabel=Metaseite anlegen preload=Vorlage:Dokumentation/preload-meta editintro=Vorlage:Dokumentation/intro-meta break=no </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 </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Wartung buttonlabel=Wartungsseite anlegen preload=Vorlage:Dokumentation/preload-wartung editintro=Vorlage:Dokumentation/intro-wartung break=no </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 </inputbox> |
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