Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
KKeine Bearbeitungszusammenfassung |
KKeine Bearbeitungszusammenfassung |
||
| Zeile 1: | Zeile 1: | ||
__NOTOC__ | __NOTOC__ | ||
== Allgemeines == | == Allgemeines == | ||
Diese Vorlage bindet die Anleitung zu den Vorlagen in einer entsprechenden Unterseite <code><nowiki>[[ | Diese Vorlage bindet die Anleitung zu den Vorlagen in einer entsprechenden Unterseite <code><nowiki>[[Seitenname/Doku]]</nowiki></code> ein. | ||
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 <code><noinclude></code>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. Diese Art der Dokumentation habe ich von [http://de.wikipedia.org/wiki/Vorlage:Dokumentation Wikipedia] und dem [http://ameisenwiki.de/index.php/Hauptseite Ameisenwiki] von Christian Witzel übernommen. | 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 <code><noinclude></code>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. Diese Art der Dokumentation habe ich von [http://de.wikipedia.org/wiki/Vorlage:Dokumentation Wikipedia] und dem [http://ameisenwiki.de/index.php/Hauptseite Ameisenwiki] von Christian Witzel übernommen. | ||
== Aufruf == | == Aufruf == | ||
Aktuelle Version vom 23. Oktober 2018, 18:43 Uhr
Allgemeines
Diese Vorlage bindet die Anleitung zu den Vorlagen in einer entsprechenden Unterseite [[Seitenname/Doku]] ein.
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. Diese Art der Dokumentation habe ich von Wikipedia und dem Ameisenwiki von Christian Witzel übernommen.
Aufruf
<noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage stellen und die Dokumentationsseite dazu [[<Seitenname>/Doku]] erstellen. Der Vorlage kann noch die entsprechende Kategorien - ebenfalls in <noinclude> - zugewiesen werden, Bsp. <noinclude>[[Category:Wiki]]</noinclude>.
Kopiervorlage und Anleitung
<big>'''Titel'''</big>
== Kopiervorlage und Anleitung ==
<pre>
{{Vorlage
| Parameter 1 =
| Parameter 2 =
| etc.
}}
Parameter:
Parameter 1 =
Parameter 2 =
</pre>
[[Category:Wiki]]