Vorlage:Dokumentation: Unterschied zwischen den Versionen
K (letzter Test vorm großen Rollback) |
K (jetzt passt es :-D) |
||
| Zeile 20: | Zeile 20: | ||
<span><br />• Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]]. </span>{{#ifexist:{{SUBJECTPAGENAME}}/Wartung| | <span><br />• Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]]. </span>{{#ifexist:{{SUBJECTPAGENAME}}/Wartung| | ||
<span><br />• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen. </span>| | <span><br />• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen. </span>| | ||
| − | <span class="metadata metadata-label" | + | <span class="metadata metadata-label">• Wartungsseite [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} erstellen]. </span> |
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | }}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | ||
<span><br />• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. </span> | <span><br />• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. </span> | ||
}}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | }}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | ||
<span><br />• Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]. </span>| | <span><br />• Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]. </span>| | ||
| − | <span class="metadata metadata-label" | + | <span class="metadata metadata-label">• Test-/Beispielseite [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} erstellen]. |
</span> | </span> | ||
}}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | }}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | ||
| Zeile 31: | Zeile 31: | ||
|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 [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet | ||
|werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]}}. </span>| | |werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]}}. </span>| | ||
| − | <span class="metadata metadata-label" | + | <span class="metadata metadata-label">• Metadatenseite [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} erstellen]. </span>}} |
<span><br />• [[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]]. | <span><br />• [[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]]. | ||
{{!)}} | {{!)}} | ||
Version vom 10. September 2008, 03:23 Uhr
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.
Inhaltsverzeichnis
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
|
• Verwendung der Vorlage in Artikeln.
|
