https://wiki.rchelifan.org/index.php?action=history&feed=atom&title=Vorlage%3ADokumentation%2FDoku 2026-04-27T03:08:15Z Versionsgeschichte dieser Seite in HeliWiki MediaWiki 1.37.2 https://wiki.rchelifan.org/index.php?title=Vorlage:Dokumentation/Doku&diff=11175&oldid=prev 2010-09-14T08:52:02Z

<p>Die Seite wurde neu angelegt: &lt;noinclude&gt;{{Dokumentation/Dokuseite}} &lt;/noinclude&gt;Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite &lt;code&gt;&lt;...</p> <p><b>Neue Seite</b></p><div>&lt;noinclude&gt;{{Dokumentation/Dokuseite}}<br /> <br /> &lt;/noinclude&gt;Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite &lt;code&gt;&lt;nowiki&gt;[[&lt;Seitenname&gt;/Doku]]&lt;/nowiki&gt;&lt;/code&gt; ein.<br /> <br /> Diese Vorlage sollte bei allen Vorlagen Verwendung finden.<br /> <br /> == Begründung ==<br /> <br /> Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.<br /> <br /> Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird: Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Trotzdem werden &lt;code&gt;&amp;lt;noinclude&gt;&lt;/code&gt;s vor den tatsächlichen Einbindungen ausgewertet, so dass man die &#039;&#039;„Pre-expand include size“&#039;&#039; 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.<br /> <br /> == Benutzung ==<br /> <br /> Diese Vorlage erwartet keine Parameter. Es reicht, wenn man &lt;code&gt;&amp;lt;noinclude&gt;&lt;nowiki&gt;{{Dokumentation}}&lt;/nowiki&gt;&amp;lt;/noinclude&gt;&lt;/code&gt; an den Anfang einer Vorlage schreibt und die entsprechende Dokumentationsseite erstellt. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).<br /> <br /> In den &#039;&#039;&#039;Unterseiten&#039;&#039;&#039; stellen folgende Codezeilen den Rückbezug sicher<br /> : &#039;&#039;&#039;/Doku&#039;&#039;&#039; &lt;code&gt;&amp;lt;noinclude&gt;&lt;nowiki&gt;{{&lt;/nowiki&gt;[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]&lt;nowiki&gt;}}&lt;/nowiki&gt;&amp;lt;/noinclude&gt;&lt;/code&gt;<br /> <br /> == Unterseiten anlegen ==<br /> <br /> {| cellspacing=&quot;8&quot; cellpadding=&quot;0&quot; class=&quot;rahmenfarbe1 centered&quot; style=&quot;font-size: 100%; border-style: solid; margin-top: 2px; margin-bottom: 2px; background-color: #eeeeff;&quot;<br /> |-<br /> |<br /> &lt;inputbox&gt;<br /> type=create<br /> default=Vorlage:&lt;Name der Vorlage&gt;/Doku<br /> buttonlabel=Dokumentationsseite anlegen<br /> preload=Vorlage:Dokumentation/preload-doku<br /> editintro=Vorlage:Dokumentation/intro-doku<br /> bgcolor=#eeeeff<br /> break=no<br /> &lt;/inputbox&gt;<br /> |}</div>

Aqua4