Vorlage:Dokumentation: Unterschied zwischen den Versionen

Aus KKWiki
Zur Navigation springenZur Suche springen
K (1 Version)
K (typos, Lokalisierung (H:VAR))
Zeile 1: Zeile 1:
−
<onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " />
+
{{Nobots}}{{Tausendfach verwendet}}<onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0em; 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>|  
+
{{#ifeq:{{NAMENSRAUM}}|{{nr: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;">[[Datei:Information icon.svg|rahmenlos|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation|alt=]]</div>
−
<div style="float:right; clear:left;">[[Datei:Information icon.svg|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation]]</div>
+
{{Überschriftensimulation 4|1=<span class="editsection">&#x5b;<span class="plainlinks">[{{vollständige_url:{{VORDERSEITE}}/Doku|action=edit}} Bearbeiten]</span>&#x5d;</span> Dokumentation}}
−
{{Überschriftensimulation 4|1=<span class="editsection">&#x5b;<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>&#x5d;</span> Dokumentation}}  
+
{{#ifexist: {{VORDERSEITE}}/Doku|
−
{{#ifexist: {{SUBJECTPAGENAME}}/Doku|
+
{{{{VORDERSEITE}}/Doku}}
−
{{{{SUBJECTPAGENAME}}/Doku}}
 
 
<br /><hr style="border:none; height:0.7ex; clear:both;" />
 
<br /><hr style="border:none; height:0.7ex; clear:both;" />
−
{{(!}} {{Bausteindesign5}}
+
{{{!}} {{Bausteindesign5}}
−
{{!}} Bei Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst Du Dich an die [[Wikipedia:WikiProjekt Vorlagen/Werkstatt|Vorlagenwerkstatt]] wenden.
+
{{!}} Bei Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst du dich an die [[Wikipedia:WikiProjekt Vorlagen/Werkstatt|Vorlagenwerkstatt]] wenden.
−
{{!)}}
+
{{!}}}
−
{{(!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info"  
+
{{{!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info"  
−
{{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Datei:Information icon.svg|30px|Information]]
+
{{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Datei:Information icon.svg|30px|Information|alt=]]
 
{{!}} style="width: 100%;" {{!}}
 
{{!}} style="width: 100%;" {{!}}
 
<ul>
 
<ul>
−
<li>{{#switch:{{{nr|<noinclude>10</noinclude>}}}
+
<li>{{#wechsle:{{ParmPart|1|{{{nr|<noinclude>10</noinclude>}}}}}
−
| 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten.
+
| 1 = {{Verwendung|nr=1}} der Vorlage auf Artikel-Diskussionsseiten.
−
| 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten.
+
| 2 = {{Verwendung|nr=2}} der Vorlage auf Benutzerseiten.
−
| 4 = {{Verwendung|ns=4}} der Vorlage auf Systemseiten.
+
| 3 = {{Verwendung|nr=3}} der Vorlage auf Benutzer-Diskussionsseiten.
−
| 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien.
+
| 4 = {{Verwendung|nr=4}} der Vorlage auf Systemseiten.
−
| 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten.
+
| 6 = {{Verwendung|nr=6}} der Vorlage bei Dateien.
−
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
+
| 10 = {{Verwendung|nr=10}} der Vorlage auf Vorlagenseiten.
−
| #default = {{Verwendung}} der Vorlage in Artikeln.
+
| 11 = {{Verwendung|nr=10}} der Vorlage auf Vorlagen-Diskussionsseiten.
 +
| 14 = {{Verwendung|nr=14}} der Vorlage auf Kategorieseiten.
 +
| #standard = {{Verwendung}} der Vorlage in Artikeln.
 
}}</li>
 
}}</li>
−
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]].</li>
+
<li>{{#wechsle:{{ParmPart|2|{{{nr|<noinclude>10</noinclude>}}}}}
−
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung
+
| 1 = {{Verwendung|nr=1}} der Vorlage auf Artikel-Diskussionsseiten.
−
  | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen.</li>
+
| 2 = {{Verwendung|nr=2}} der Vorlage auf Benutzerseiten.
−
  | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen].</li>
+
| 3 = {{Verwendung|nr=3}} der Vorlage auf Benutzer-Diskussionsseiten.
 +
| 4 = {{Verwendung|nr=4}} der Vorlage auf Systemseiten.
 +
| 6 = {{Verwendung|nr=6}} der Vorlage bei Dateien.
 +
| 10 = {{Verwendung|nr=10}} der Vorlage auf Vorlagenseiten.
 +
| 11 = {{Verwendung|nr=10}} der Vorlage auf Vorlagen-Diskussionsseiten.
 +
| 14 = {{Verwendung|nr=14}} der Vorlage auf Kategorieseiten.
 +
}}</li>
 +
<li> Diese Dokumentation befindet sich [[{{VORDERSEITE}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata"><span /> ([{{vollständige_url:{{VORDERSEITE}}/Doku|action=edit}} Bearbeiten]/[{{vollständige_url:{{VORDERSEITE}}/Doku|action=history}} Versionen]{{#ifexist:{{DISKUSSIONSSEITE}}/Doku|/[[{{DISKUSSIONSSEITE}}/Doku|Diskussion]]}})</span>.</li>
 +
{{#ifexist: {{VORDERSEITE}}/Meta
 +
| <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMENSRAUM}}|{{nr:2}}
 +
  | in [[{{VORDERSEITE}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet
 +
  | werden [[{{VORDERSEITE}}/Meta|von einer Unterseite eingebunden]]<span class="metadata"><span /> ([{{vollständige_url:{{VORDERSEITE}}/Meta|action=edit}} Bearbeiten]/[{{vollständige_url:{{VORDERSEITE}}/Meta|action=history}} Versionen]{{#ifexist:{{DISKUSSIONSSEITE}}/Meta|/[[{{DISKUSSIONSSEITE}}/Meta|Diskussion]]}})</span>
 +
  }}.</li>
 +
| <li class="metadata metadata-label">[{{vollständige_url:{{VORDERSEITE}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li>
 +
}}
 +
{{#ifexist:{{VORDERSEITE}}/Wartung
 +
  | <li>Für diese Vorlage existiert eine [[{{VORDERSEITE}}/Wartung|Wartungsseite]]<span class="metadata"><span /> ([{{vollständige_url:{{VORDERSEITE}}/Wartung|action=edit}} Bearbeiten]/[{{vollständige_url:{{VORDERSEITE}}/Wartung|action=history}} Versionen]{{#ifexist:{{DISKUSSIONSSEITE}}/Wartung|/[[{{DISKUSSIONSSEITE}}/Wartung|Diskussion]]}})</span> zum Auffinden fehlerhafter Verwendungen.</li>
 +
  | <li class="metadata metadata-label">[{{vollständige_url:{{VORDERSEITE}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen].</li>
 
}}
 
}}
−
{{#ifexist:{{SUBJECTPAGENAME}}/XML
+
{{#ifexist:{{VORDERSEITE}}/XML
−
  | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]].</li>
+
  | <li>Für diese Vorlage existiert eine [[{{VORDERSEITE}}/XML|XML-Beschreibung]]<span class="metadata"><span /> ([{{vollständige_url:{{VORDERSEITE}}/XML|action=edit}} Bearbeiten]/[{{vollständige_url:{{VORDERSEITE}}/XML|action=history}} Versionen]{{#ifexist:{{DISKUSSIONSSEITE}}/XML|/[[{{DISKUSSIONSSEITE}}/XML|Diskussion]]}})</span> für den [[Wikipedia:Helferlein/Vorlagen-Meister|Vorlagenmeister]].</li>
 
  | <li class="metadata metadata-label">[[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]</li>
 
  | <li class="metadata metadata-label">[[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]</li>
 
}}
 
}}
−
{{#ifexist:{{SUBJECTPAGENAME}}/Test
+
{{#ifexist:{{VORDERSEITE}}/Test
−
  | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]].</li>
+
  | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{VORDERSEITE}}/Test|Testseite]]<span class="metadata"><span /> ([{{vollständige_url:{{VORDERSEITE}}/Test|action=edit}} Bearbeiten]/[{{vollständige_url:{{VORDERSEITE}}/Test|action=history}} Versionen]{{#ifexist:{{DISKUSSIONSSEITE}}/Test|/[[{{DISKUSSIONSSEITE}}/Test|Diskussion]]}})</span>.</li>
−
  | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li>
+
  | <li class="metadata metadata-label">[{{vollständige_url:{{VORDERSEITE}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li>
 
}}
 
}}
−
{{#ifexist:{{SUBJECTPAGENAME}}/Druck
+
{{#ifexist:{{VORDERSEITE}}/Druck
−
  | <li>Es existiert eine spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]] für die [[Hilfe:Buchfunktion|Buchfunktion]].</li>
+
  | <li>Es existiert eine spezielle [[{{VORDERSEITE}}/Druck|Druckversion]]<span class="metadata"><span /> ([{{vollständige_url:{{VORDERSEITE}}/Druck|action=edit}} Bearbeiten]/[{{vollständige_url:{{VORDERSEITE}}/Druck|action=history}} Versionen]{{#ifexist:{{DISKUSSIONSSEITE}}/Druck|/[[{{DISKUSSIONSSEITE}}/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>
+
  | <li class="metadata metadata-label">[{{vollständige_url:{{VORDERSEITE}}/Druck|action=edit&preload=Vorlage:Dokumentation/preload-druck}} Druckversion erstellen].</li>
 
}}
 
}}
−
{{#ifexist: {{SUBJECTPAGENAME}}/Meta
+
{{#ifexist:{{VORDERSEITE}}/Editnotice
−
  | <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}}
+
  | <li>Es existiert eine [[{{VORDERSEITE}}/Editnotice|Editnotice]]<span class="metadata"><span /> ([{{vollständige_url:{{VORDERSEITE}}/Editnotice|action=edit}} Bearbeiten]/[{{vollständige_url:{{VORDERSEITE}}/Editnotice|action=history}} Versionen]{{#ifexist:{{DISKUSSIONSSEITE}}/Editnotice|/[[{{DISKUSSIONSSEITE}}/Editnotice|Diskussion]]}})</span>, die beim Bearbeiten angezeigt wird.</li>
−
  | in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet
+
  | <li class="metadata metadata-label">[{{vollständige_url:{{VORDERSEITE}}/Editnotice|action=edit&preload=Vorlage:Dokumentation/preload-editnotice}} Editnotice erstellen].</li>
−
  | werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]
 
−
  }}.</li>
 
−
  | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li>
 
 
}}
 
}}
−
<li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li>
+
<li>[[Spezial:Präfixindex/{{VORDERSEITE}}/|Liste der Unterseiten]].</li>
 
</ul>
 
</ul>
−
{{!)}}  
+
{{!}}}
 
|<span class="plainlinks" style="font-size:150%;">
 
|<span class="plainlinks" style="font-size:150%;">
−
* [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]  
+
* [{{vollständige_url:{{VORDERSEITE}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]  
−
{{#ifexist:{{SUBJECTPAGENAME}}/Meta||  
+
{{#ifexist:{{VORDERSEITE}}/Meta||
−
* [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}  
+
* [{{vollständige_url:{{VORDERSEITE}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}  
−
{{#ifexist:{{SUBJECTPAGENAME}}/Test||  
+
{{#ifexist:{{VORDERSEITE}}/Wartung||
−
* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}  
+
* [{{vollständige_url:{{VORDERSEITE}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
−
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung||  
+
{{#ifexist:{{VORDERSEITE}}/Test||
−
* [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
+
* [{{vollständige_url:{{VORDERSEITE}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}  
−
</span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}|
+
</span>{{#ifeq:{{NAMENSRAUM}}|{{nr:10}}|
−
[[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]]
+
[[Kategorie:Vorlage:nicht dokumentiert|{{SEITENNAME}}]]
 
}}
 
}}
 
}}
 
}}
 
<div style="clear:both;" />
 
<div style="clear:both;" />
−
</div></div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
+
{{#ifeq:{{NAMENSRAUM}}|{{nr:2}}||{{#ifexist: {{VORDERSEITE}}/Meta|{{{{VORDERSEITE}}/Meta}}
 
}}}}
 
}}}}
−
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " /></onlyinclude>
+
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0em; height:0.7ex;" /></onlyinclude>
−
<noinclude>{{Wikipedia}}</noinclude>
 

Version vom 28. November 2012, 06:00 Uhr

Vorlage:Nobots

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.
<span style="visibility:hidden" id="[Bearbeiten] Dokumentation"><span id="Anker:[Bearbeiten] Dokumentation">[Bearbeiten] Dokumentation

Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein.

Diese Vorlage sollte bei allen Vorlagen Verwendung finden.

Begründung

Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.

Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Trotzdem werden <noinclude>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 <noinclude> {{Dokumentation}} </noinclude> ans Ende einer Vorlage schreibt und die entsprechende Dokumentationsseite erstellt. Eine Unterseite namens /Meta kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt Besonderheiten lesen), ansonsten können diese mit in die noinclude-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem 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>

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
Eine solche Unterseite ist vorallem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten.
/XML
Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis).
/Wartung
Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).
/Test
Ein Hinweis wird auch für Testunterseiten ausgegeben.

Unterseiten anlegen


Bei Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden.
Abgerufen von „http://www.keltischekirche.de/kkwiki/index.php?title=Vorlage:Dokumentation&oldid=6626“