Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
wp>Mfb (Änderung 147810746 von Matthiasb rückgängig gemacht; eindeutige Situation in der Diskussion auf der Vorlagenwerkstatt) |
wp>Matthiasb K (Änderungen von Mfb (Diskussion) auf die letzte Version von Matthiasb zurückgesetzt) |
||
| Zeile 17: | Zeile 17: | ||
; /Meta | ; /Meta | ||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki></noinclude><includeonly> … Meta … </includeonly></code> | : <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki></noinclude><includeonly> … Meta … </includeonly></code> | ||
; /Test | ; /Test | ||
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki></noinclude></code> | : <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki></noinclude></code> | ||
| Zeile 34: | Zeile 33: | ||
; <code>/Meta</code> {{Anker|Meta-Unterseite}} | ; <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> | ; <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. | : 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. | ||
| Zeile 58: | Zeile 53: | ||
preload=Vorlage:Dokumentation/preload-doku | preload=Vorlage:Dokumentation/preload-doku | ||
editintro=Vorlage:Dokumentation/intro-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 | break=no | ||
</inputbox> | </inputbox> | ||
Version vom 8. November 2015, 04:08 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
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