Vorlage:Dokumentation
Aus Kitakien
K (jetzt passt es :-D) |
K (auf ein Letztes gegen Anzeigefehler in Firefox) |
||
| Zeile 10: | Zeile 10: | ||
|Beschreibung = keine | |Beschreibung = keine | ||
}}</div> | }}</div> | ||
| - | {{Überschriftensimulation 4|1=<span class="editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>]</span> | + | {{Überschriftensimulation 4|1=<span class="editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>]</span> Dokumentation}} |
{{#ifexist: {{SUBJECTPAGENAME}}/Doku| | {{#ifexist: {{SUBJECTPAGENAME}}/Doku| | ||
{{{{SUBJECTPAGENAME}}/Doku}} | {{{{SUBJECTPAGENAME}}/Doku}} | ||
| Zeile 17: | Zeile 17: | ||
{{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Bild:Information icon.svg|30px|Information]] | {{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Bild:Information icon.svg|30px|Information]] | ||
{{!}} style="width: 100%;" {{!}} | {{!}} style="width: 100%;" {{!}} | ||
| - | <span>• {{Verwendung}} der Vorlage in Artikeln. </span> | + | <div><span>• {{Verwendung}} der Vorlage in Artikeln. </span></div> |
| - | < | + | <div><span>• Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]].</span></div>{{#ifexist:{{SUBJECTPAGENAME}}/Wartung| |
| - | < | + | <div><span>• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen. </span></div>| |
| - | <span class="metadata metadata-label">• | + | <div><span class="metadata metadata-label">• [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]. </span></div> |
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | }}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | ||
| - | < | + | <div><span>• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. </span></div> |
}}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | }}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | ||
| - | < | + | <div><span>• Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]. </span></div>| |
| - | <span class="metadata metadata-label">• | + | <div><span class="metadata metadata-label">• [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</span></div> |
| - | </span> | + | |
}}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | }}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | ||
| - | < | + | <div><span>• 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 | |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></div>| |
| - | <span class="metadata metadata-label">• | + | <div><span class="metadata metadata-label">• [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]. </span></div>}} |
| - | < | + | <div><span>• [[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]]. |
{{!)}} | {{!)}} | ||
| | | | ||
Version vom 01:30, 10. Sep. 2008
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.
Inhaltsverzeichnis |
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.
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> - /Test
<noinclude>{{Dokumentation/Testseite}}</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
/Test- Ein Hinweis wird auch für Testunterseiten ausgegeben.
Unterseiten anlegen
|
|
| Datei:Information icon.svg |
• Verwendung der Vorlage in Artikeln.
• Diese Dokumentation wird von einer Unterseite eingebunden.
• Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der Testseite.
|
