Vorlage:Dokumentation
Aus MosaPedia
(Unterschied zwischen Versionen)
Kobold (Diskussion | Beiträge) (Helfer zur Einbindung der Dokumentations-Unterseite von Vorlagen) |
Kobold (Diskussion | Beiträge) (+Hinweis auf eingebundene Unterseite) |
||
| Zeile 1: | Zeile 1: | ||
| - | + | <onlyinclude> | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
<div style="margin:0.5em; padding:0.5em; clear:both; border:3px solid #96CDCD;" id="Vorlage_Dokumentation"> | <div style="margin:0.5em; padding:0.5em; clear:both; border:3px solid #96CDCD;" id="Vorlage_Dokumentation"> | ||
{{#ifexist: {{SUBJECTPAGENAME}}/Doku| | {{#ifexist: {{SUBJECTPAGENAME}}/Doku| | ||
| - | {{{{SUBJECTPAGENAME}}/Doku}}| | + | <div style="background-color:#96CDCD; margin:0; margin-bottom:1em; padding:1em" |
| + | >Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]] ([{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten] / [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Doku| / [[{{TALKPAGENAME}}/Doku|Diskussion]]}}). | ||
| + | </div>{{{{SUBJECTPAGENAME}}/Doku}}| | ||
Die Seite [[{{SUBJECTPAGENAME}}/Doku]] ist nicht vorhanden. [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Doku-Seite erstellen] | Die Seite [[{{SUBJECTPAGENAME}}/Doku]] ist nicht vorhanden. [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Doku-Seite erstellen] | ||
{{#ifeq:{{NAMESPACE}}|{{ns:10}}|[[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]]}} | {{#ifeq:{{NAMESPACE}}|{{ns:10}}|[[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]]}} | ||
}}</div> | }}</div> | ||
</onlyinclude> | </onlyinclude> | ||
Aktuelle Version vom 03:08, 4. Jan. 2011
Die Vorlage Dokumentation ist ein Helfer zur Unterstützung der Vorlagen-Dokumentation in Unterseiten.
[Bearbeiten] Zweck
Zu einer Vorlage:XYZ wird die Dokumentation in eine Unterseite Vorlage:XYZ/Doku ausgelagert und (nur beim direkten Betrachten der Vorlage) von dieser eingebunden.
Vorteile:
- Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
- Die Dokumentation kann bearbeitet werden, während die Vorlage selbst gesperrt ist.
- Nach dem Bearbeiten der Dokumentation ist kein Neuaufbau von Seiten erforderlich, die die Vorlage einbinden. (Bei häufigen Bearbeitungen bzw. häufig eingebundenen Vorlagen reduziert dies die Serverlast.)
[Bearbeiten] Funktion
Das Einfügen von {{Dokumentation}} in eine Vorlage:XYZ bewirkt folgendes:
- Wenn die Seite Vorlage:XYZ/Doku existiert, wird diese eingebunden.
- Falls die Doku-Unterseite (noch) nicht existiert, wird Vorlage:XYZ zur Kategorie: Vorlage:nicht dokumentiert hinzugefügt.
Damit beides nur beim direkten Betrachten der Vorlage:XYZ stattfindet, muss die Einbindung {{Dokumentation}} von <noinclude>...</noinclude> eingeschlossen werden.
(Mehr zum Thema Vorlageneinbindung unter http://www.mediawiki.org/wiki/Help:Templates/de und http://www.mediawiki.org/wiki/Help:Transclusion.)
[Bearbeiten] Benutzung
Um zu einer Vorlage:XYZ eine ausgelagerte Dokumentation hinzuzufügen,
- füge
<noinclude>{{Dokumentation}}</noinclude>in die Vorlage:XYZ ein (üblicherweise am Ende), - erstelle die Dokumentations-Unterseite Vorlage:XYZ/Doku.
