Vorlage:Dokumentation: Unterschied zwischen den Versionen

Aus Lechzikon
Wechseln zu: Navigation, Suche
K (t)
K (5 Versionen)
 
(3 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
{{Tausendfach verwendet}}<onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " />
+
{{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>|  
+
{{#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 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:Info-Punkt.png|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation]]</div>
+
<div style="float:right; clear:left;">[[Datei:Information icon.svg|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation|alt=]]</div>
{{Überschriftensimulation 4|1=<span class="editsection">&#x5b;<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/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: {{SUBJECTPAGENAME}}/Doku|
 
{{#ifexist: {{SUBJECTPAGENAME}}/Doku|
 
{{{{SUBJECTPAGENAME}}/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: [[Hilfe:Vorlagen|Vorlage]]  
+
{{!}} 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"  
 
{{{!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info"  
{{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Datei:Info-Punkt.png|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:{{ParmPart|1|{{{nr|<noinclude>10</noinclude>}}}}}
 
<li>{{#switch:{{ParmPart|1|{{{nr|<noinclude>10</noinclude>}}}}}
Zeile 36: Zeile 35:
 
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
 
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
 
}}</li>
 
}}</li>
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]].</li>
+
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Doku|/[[{{TALKPAGENAME}}/Doku|Diskussion]]}})</span>.</li>
 
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung
 
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung
  | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen.</li>
+
  | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]]<span class="metadata"> ([{{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>
 
  | <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"> ([{{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
 
{{#ifexist:{{SUBJECTPAGENAME}}/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 [[{{SUBJECTPAGENAME}}/Test|Testseite]]<span class="metadata"> ([{{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>
 
  | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li>
 
}}
 
}}
 
{{#ifexist:{{SUBJECTPAGENAME}}/Druck
 
{{#ifexist:{{SUBJECTPAGENAME}}/Druck
  | <li>Es existiert eine spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]] für die [[Hilfe:Buchfunktion|Buchfunktion]].</li>
+
  | <li>Es existiert eine spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Druck|/[[{{TALKPAGENAME}}/Druck|Diskussion]]}})</span> für die [[Wikipedia:de: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">[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit&preload=Vorlage:Dokumentation/preload-druck}} Druckversion erstellen].</li>
 
}}
 
}}
 
{{#ifexist: {{SUBJECTPAGENAME}}/Meta
 
{{#ifexist: {{SUBJECTPAGENAME}}/Meta
  | <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}}  
+
  | <li>Die Metadaten ([[Wikipedia:de:Hilfe:Kategorien|Kategorien]] und [[Wikipedia:de:Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}}
   | in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet  
+
   | in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Wikipedia:de:Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet
   | werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]
+
   | werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Meta|/[[{{TALKPAGENAME}}/Meta|Diskussion]]}})</span>
 
   }}.</li>
 
   }}.</li>
 
  | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li>
 
  | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li>
 
}}
 
}}
 
{{#ifexist:{{SUBJECTPAGENAME}}/Editnotice
 
{{#ifexist:{{SUBJECTPAGENAME}}/Editnotice
  | <li>Es existiert eine [[{{SUBJECTPAGENAME}}/Editnotice|Editnotice]], die beim Bearbeiten angezeigt wird.</li>
+
  | <li>Es existiert eine [[{{SUBJECTPAGENAME}}/Editnotice|Editnotice]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Editnotice|/[[{{TALKPAGENAME}}/Editnotice|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 class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit&preload=Vorlage:Dokumentation/preload-editnotice}} Editnotice erstellen].</li>
 
}}
 
}}
Zeile 65: Zeile 68:
 
|<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]  
 
* [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]  
{{#ifexist:{{SUBJECTPAGENAME}}/Meta||  
+
{{#ifexist:{{SUBJECTPAGENAME}}/Meta||
 
* [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}  
 
* [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}  
{{#ifexist:{{SUBJECTPAGENAME}}/Test||  
+
{{#ifexist:{{SUBJECTPAGENAME}}/Test||
 
* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}  
 
* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}  
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung||  
+
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung||
 
* [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
 
* [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
 
</span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}|
 
</span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}|
Zeile 75: Zeile 78:
 
}}
 
}}
 
}}
 
}}
 
+
<div style="clear:both;" />
 
</div></div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
 
</div></div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
 
}}}}
 
}}}}
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " /></onlyinclude>
+
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex;" /></onlyinclude>

Aktuelle Version vom 13. April 2011, 23:02 Uhr

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

[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 verwendet werden.

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

2 Benutzung

Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] 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>
/Druck <noinclude>{{Dokumentation/Druckversion}}</noinclude>
/Editnotice <noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>
/Unterseite <noinclude>{{Dokumentation/Unterseite}}</noinclude>

3 Besonderheiten

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

3.1 Unterseiten

/Meta
Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.
/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.
/Druck
Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
/Editnotice
Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

4 Unterseiten anlegen

Wenn man das Wikipedia:de:MediaWiki:Gadget-Personendaten in den Einstellungen aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.



Bei Fragen zu dieser Vorlage kannst Du Dich an die Vorlagenwerkstatt wenden.