Quelltext der Seite Vorlage:Dokumentation/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
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.
__TOC__
== Begründung ==

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
* Insbesondere führt eine kleine Änderung in der Dokumentation nicht dazu, dass Tausende einbindender Seiten neu generiert werden müssen.
* In der Versionsgeschichte der Programmierungsseite erscheinen nur noch Änderungen, die die wirksamen Einbindungen betreffen.

== Benutzung ==

Diese Vorlage erwartet keine Parameter. Es reicht, wenn der programmierte Code in <code>&lt;onlyinclude></code> sowie <code>&lt;/onlyinclude></code> '''eingeschlossen''' wird und dann <code><nowiki>{{Dokumentation}}</nowiki></code> '''an das Ende einer Vorlage''' geschrieben wird; danach kann die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt werden. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).''

In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher:
; /Doku
: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
; /Meta
: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki>&lt;/noinclude>&lt;includeonly> … Meta … &lt;/includeonly></code>
: ''Hinweis: Diese Methode ist [[#Meta-Unterseite|veraltet]] und wird zurückgebaut (integriert in /Doku).''
; /Test
: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
; /Wartung
: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
; /Editnotice
: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Editnoticeseite|Dokumentation/Editnoticeseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
; /Unterseite
: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Unterseite|Dokumentation/Unterseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>

== Besonderheiten ==

Wenn sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite in Kategorien einsortiert.

=== Unterseiten ===

; <code>/Meta</code> {{Anker|Meta-Unterseite}}
: Eine solche Unterseite war vor allem für [[Hilfe:Seitenschutz|vollgeschützte Seiten]] gedacht, die ansonsten nicht kategorisiert werden konnten, und sie sollte Interwiki-Bots das Beschreiben ermöglichen, ohne durch Halbschutz blockiert zu werden und auf den Beobachtungslisten zu stören. Diese Unterseite nahm auch Kategorisierungen auf.
:* Interwiki-Links befinden sich inzwischen auf [[Wikipedia:Wikidata|Wikidata]].
:* Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in <code>&lt;includeonly></code> eingeschlossen am Ende von <code>/Doku</code> eingefügt werden.
:* Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände werden aufgelöst.
:* Siehe [[Hilfe:Vorlagendokumentation #Meta-Daten]].
; <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>
: Ein 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
</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>/Editnotice
 buttonlabel=Editnotice anlegen
 preload=Vorlage:Dokumentation/preload-editnotice
 editintro=Vorlage:Dokumentation/intro-editnotice
 break=no
</inputbox>
|}

== Interne Wartung ==
* [[:Kategorie:Wikipedia:Vorlagenfehler/Vorlage:Dokumentation]]

== Weitere Informationen ==
* [[Hilfe:Vorlagendokumentation]]
Interne Hiilfsvorlagen, einzeln für besondere Fälle nutzbar:
* [[Vorlage:Dokumentation/ruler]] – einheitliche Trennlinie
* [[Vorlage:Dokumentation/header]] – Große Überschrift
* [[Vorlage:Dokumentation/footer]] – Fußbereich mit standardisierten Zusatzinfos

{{Tausendfach verwendet}}
<includeonly>
[[Kategorie:Vorlage:für Vorlagen| ]]
[[Kategorie:Vorlage:Metadokumentation| ]]
</includeonly>