Ben: Die Seite wurde neu angelegt: „{{Dokumentation/Dokuseite}} {{Tausendfach verwendet}} Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade sie…“

2013-11-14T22:06:35Z

Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}}</noinclude> {{Tausendfach verwendet}} Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade sie…“

Neue Seite

<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. 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
; /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>
; /Druck : <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Druckversion|Dokumentation/Druckversion]]<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>
: 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.
; <code>/XML</code>
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Wikipedia:Helferlein/Vorlagen-Meister|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>/Druck</code>
: Eine spezielle Version der Vorlage, die zusammen mit der [[Hilfe:Buchfunktion|Buchfunktion]] benutzt wird.
; <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=Metadatenseite 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>/Druck
buttonlabel=Druckversion anlegen
preload=Vorlage:Dokumentation/preload-druck
editintro=Vorlage:Dokumentation/intro-druck
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.

Vorlage:Dokumentation/Doku - Versionsgeschichte

Ben: Die Seite wurde neu angelegt: „{{Dokumentation/Dokuseite}} {{Tausendfach verwendet}} Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade sie…“