Vorlage:Dokumentation: Unterschied zwischen den Versionen

Aus KKWiki
Zur Navigation springenZur Suche springen
K
K (212 Versionen)
 
(211 dazwischenliegende Versionen von 40 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung|{{Wartungshinweis}}
+
<hr class="rulerdocumentation hintergrundfarbe6" style="height:.7ex; margin:1em 0;">
−
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML|{{XML-Hinweis}}
+
{{#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 class="hintergrundfarbe1 rahmenfarbe1" style="margin-top:0.5em 0; padding:0 0.5em; clear:both; border-style:solid;">
+
<div style="clear:left; float:right;">[[Datei:Information icon.svg|rahmenlos|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation|alt=]]</div>
−
{{Überschriftensimulation 2|Dokumentation}}
+
{{Überschriftensimulation 4|1=Dokumentation<span class="mw-editsection">&#x5b;<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} {{int:Editsection}}]</span>&#x5d;</span>}}
−
: <small class="plainlinks">Diese Dokumentation wird aus [[{{SUBJECTPAGENAME}}/doc]] eingebunden. ([[{{SUBJECTPAGENAME}}/doc|Ansehen]] | [{{fullurl:{{SUBJECTPAGENAME}}/doc|action=edit{{#ifexist: {{SUBJECTPAGENAME}}/doc ||&amp;preload=Vorlage:Dokumentation/preload}}}} Bearbeiten] | [{{fullurl:{{SUBJECTPAGENAME}}/doc|action=history}} Versionen]) </small>
+
{{#ifexist: {{SUBJECTPAGENAME}}/Doku|
−
{{ {{#ifexist:{{SUBJECTPAGENAME}}/doc|{{SUBJECTPAGENAME}}/doc|ns:0}} }}
+
{{{{SUBJECTPAGENAME}}/Doku}}
−
<div style="clear:both;"></div>
+
<hr style="border:none; clear:both; height:.7ex; margin:1em 0;">
−
</div>
+
{{{!}} {{Bausteindesign5}}
 +
{{!}} Bei technischen Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst du dich an die [[Wikipedia:WikiProjekt Vorlagen/Werkstatt|Vorlagenwerkstatt]] wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die [[{{TALKPAGENAME}}|Diskussionsseite]].
 +
{{!}}}
 +
{{{!}} class="plainlinks" id="Dokumentation.Info" style="border-collapse:collapse; margin:2px 0;"
 +
{{!}} style="padding:5px; vertical-align:top; width:40px;" {{!}} [[Datei:Information icon.svg|30px|Information|alt=]]
 +
{{!}} style="padding:0; width:100%;" {{!}}
 +
<ul>
 +
<li>[{{fullurl:Spezial:Linkliste/{{FULLPAGENAME}}|hideredirs=1&hidelinks=1}} Verwendungen] dieser Vorlage</li>
 +
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Doku|/[[{{TALKPAGENAME}}/Doku|Diskussion]]}})</span>.</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"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Meta|/[[{{TALKPAGENAME}}/Meta|Diskussion]]}})</span>
 +
  }}.</li>
 +
|
 +
}}
 +
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung
 +
| <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]]<span class="metadata"><span /> ([{{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">[{{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"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/XML|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/XML|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/XML|/[[{{TALKPAGENAME}}/XML|Diskussion]]}})</span> für den [[Wikipedia:Technik/Skin/Gadgets/Vorlagenmeister|Vorlagenmeister]].</li>
 +
| <li class="metadata">[[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]<!-- Toolserver 2014 --></li>
 +
}}
 +
{{#ifexist:{{SUBJECTPAGENAME}}/Test
 +
| <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]<span class="metadata"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Test|/[[{{TALKPAGENAME}}/Test|Diskussion]]}})</span>.</li>
 +
| <li class="metadata">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li>
 +
}}
 +
{{#ifexist:{{SUBJECTPAGENAME}}/Editnotice
 +
| <li>Es existiert ein [[{{SUBJECTPAGENAME}}/Editnotice|Bearbeitungshinweis]]<span class="metadata"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Editnotice|/[[{{TALKPAGENAME}}/Editnotice|Diskussion]]}})</span>, der beim Bearbeiten der Vorlage angezeigt wird.</li>
 +
| <li class="metadata">[{{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}}/Wartung||
 +
* [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
 +
{{#ifexist:{{SUBJECTPAGENAME}}/Test||
 +
* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}
 +
</span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}|
 +
[[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]]
 +
}}
 +
}}
 +
{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
 +
}}}}
 +
}}<hr class="rulerdocumentation hintergrundfarbe6" style="height:.7ex; margin:1em 0;">

Aktuelle Version vom 23. September 2014, 21:20 Uhr

<span style="visibility:hidden" id="Dokumentation[Bearbeiten]"><span id="Anker:Dokumentation[Bearbeiten]">Dokumentation[Bearbeiten]

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 technischen Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite.
Abgerufen von „http://www.keltischekirche.de/kkwiki/index.php?title=Vorlage:Dokumentation&oldid=6660“