Quelltext der Seite Vorlage:Dokumentation

{{Tausendfach verwendet}}<onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " />
{{#ifeq:{{NAMESPACE}}|{{ns:0}}|<strong class="error">Achtung: Die {{Vorlage|Dokumentation}} wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt <code>&lt;noinclude&gt;</code> in einer eingebundenen Vorlage oder die Kapselung ist fehlerhaft. Bitte {{Bearbeiten|text=entferne diesen Fehler}}.</strong>|
<div id="framedocumentation"><div class="rahmenfarbe1" style="margin-bottom:0.5em; padding:0.5em; padding-top:0; clear:left; border-style:solid;" id="Vorlage_Dokumentation">
<div style="float:right; clear:left;">&nbsp;</div>
{{Überschriftensimulation 4|1=<span class="editsection">&#x5b;<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>&#x5d;</span> Dokumentation}}
{{#ifexist: {{SUBJECTPAGENAME}}/Doku|
{{{{SUBJECTPAGENAME}}/Doku}}
<br /><hr style="border:none; height:0.7ex; clear:both;" />
{{{!}} {{Bausteindesign5}}
{{!}} Bei Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst Du Dich an die [[Wikipedia:de:Wikipedia:WikiProjekt Vorlagen/Werkstatt|Vorlagenwerkstatt]] wenden.
{{!}}}
{{{!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info"
{{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} 
{{!}} style="width: 100%;" {{!}}
<ul>
<li>{{#switch:{{ParmPart|1|{{{nr|<noinclude>10</noinclude>}}}}}
| 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten.
| 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten.
| 3 = {{Verwendung|ns=3}} der Vorlage auf Benutzer-Diskussionsseiten.
| 4 = {{Verwendung|ns=4}} der Vorlage auf Systemseiten.
| 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien.
| 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten.
| 11 = {{Verwendung|ns=10}} der Vorlage auf Vorlagen-Diskussionsseiten.
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
| #default = {{Verwendung}} der Vorlage in Artikeln.
}}</li>
<li>{{#switch:{{ParmPart|2|{{{nr|<noinclude>10</noinclude>}}}}}
| 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten.
| 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten.
| 3 = {{Verwendung|ns=3}} der Vorlage auf Benutzer-Diskussionsseiten.
| 4 = {{Verwendung|ns=4}} der Vorlage auf Systemseiten.
| 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien.
| 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten.
| 11 = {{Verwendung|ns=10}} der Vorlage auf Vorlagen-Diskussionsseiten.
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
}}</li>
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata metadata-inline"> ([{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Doku|/[[{{TALKPAGENAME}}/Doku|Diskussion]]}})</span>.</li>
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung
 | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]]<span class="metadata metadata-inline"> ([{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Wartung|/[[{{TALKPAGENAME}}/Wartung|Diskussion]]}})</span> zum Auffinden fehlerhafter Verwendungen.</li>
 | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen].</li>
}}
{{#ifexist:{{SUBJECTPAGENAME}}/XML
 | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]]<span class="metadata metadata-inline"> ([{{fullurl:{{SUBJECTPAGENAME}}/XML|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/XML|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/XML|/[[{{TALKPAGENAME}}/XML|Diskussion]]}})</span> für den [[Wikipedia:de:Wikipedia:Helferlein/Vorlagen-Meister|Vorlagenmeister]].</li>
 | <li class="metadata metadata-label">[[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]</li>
}}
{{#ifexist:{{SUBJECTPAGENAME}}/Test
 | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]<span class="metadata metadata-inline"> ([{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Test|/[[{{TALKPAGENAME}}/Test|Diskussion]]}})</span>.</li>
 | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li>
}}
{{#ifexist:{{SUBJECTPAGENAME}}/Druck
 | <li>Es existiert eine spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]]<span class="metadata metadata-inline"> ([{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Druck|/[[{{TALKPAGENAME}}/Druck|Diskussion]]}})</span> für die [[Hilfe:Buchfunktion|Buchfunktion]].</li>
 | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit&preload=Vorlage:Dokumentation/preload-druck}} Druckversion erstellen].</li>
}}
{{#ifexist: {{SUBJECTPAGENAME}}/Meta
 | <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}}
   | in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet
   | werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]<span class="metadata metadata-inline"> ([{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Meta|/[[{{TALKPAGENAME}}/Meta|Diskussion]]}})</span>
   }}.</li>
 | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li>
}}
{{#ifexist:{{SUBJECTPAGENAME}}/Editnotice
 | <li>Es existiert eine [[{{SUBJECTPAGENAME}}/Editnotice|Editnotice]]<span class="metadata metadata-inline"> ([{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Editnotice|/[[{{TALKPAGENAME}}/Editnotic|Diskussion]]}})</span>, die beim Bearbeiten angezeigt wird.</li>
 | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit&preload=Vorlage:Dokumentation/preload-editnotice}} Editnotice erstellen].</li>
}}
<li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li>
</ul>
{{!}}}
|<span class="plainlinks" style="font-size:150%;">
* [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]
{{#ifexist:{{SUBJECTPAGENAME}}/Meta||
* [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}
{{#ifexist:{{SUBJECTPAGENAME}}/Test||
* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung||
* [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
</span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}|
[[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]]
}}
}}
<!-- <div style="clear:both;" /> -->
</div></div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
}}}}
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " /></onlyinclude>

<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.

Diese Vorlage sollte bei allen Vorlagen verwendet werden.

== Begründung ==

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher und entlastet vor allem den Parser: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt ohnehin wieder weggelassen wird. Trotzdem werden <code>&lt;noinclude></code>s vor den tatsächlichen Einbindungen ausgewertet, so dass man die ''„Pre-expand include size“'' drastisch drücken kann, wenn man die Dokumentationen in Unterseiten schreibt. Daher sollte die Beschreibung immer aus der eigentlichen Vorlage ausgelagert werden. Somit ermöglicht man die Nutzung von mehr Vorlagen pro Artikelseite.

== Benutzung ==

Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/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 [[Spezial:Interwiki-Liste|Interwikilinks]]. Nach dem Erstellen der Dokumentation werden einem 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>
: '''/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>
: '''/Druck''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Druckversion|Dokumentation/Druckversion]]<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, werden in Kategorien einsortiert.

=== Unterseiten ===

; <code>/Meta</code>
: Eine solche Unterseite ist vor allem für [[Wikipedia:de:Wikipedia:Geschützte Seiten|vollgesperrte Seiten]] gedacht, die ansonsten nicht interwikifiziert werden könnten.
; <code>/XML</code>
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Wikipedia:de: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 nogrid rahmenfarbe1 centered" style="font-size: 100%; border-style: solid; margin-top: 2px; margin-bottom: 2px; background-color: #eeeeff; text-align:left;"
|
<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 seine [[Spezial:Meine Benutzerseite/vector.css|vector.css]] (oder [[Spezial:Meine Benutzerseite/monobook.css|monobook.css]]) um <source lang="css">
.metadata { display:block !important; }
.metadata-inline { display:inline !important; }
</source> erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.
</noinclude>

<noinclude>[[Kategorie:Vorlage:für Vorlagen]]
[[Kategorie:Vorlage:nur Dokumentation]]</noinclude>