Vorlage:Dokumentation/Doku

Aus Kitakien

< Vorlage:Dokumentation(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
K (Tippfehler)
K
 
(Der Versionsvergleich bezieht 36 dazwischenliegende Versionen mit ein.)
Zeile 1: Zeile 1:
-
<noinclude>{{Dokumentation/Unterseite}}
+
<noinclude>{{Dokumentation/Dokuseite}}
 +
</noinclude>Diese [[Hilfe:Vorlagen|Vorlage]] zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein.
-
</noinclude>Diese Vorlage zeigt eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/doc]]</nowiki></code> ein.
+
Diese Vorlage sollte bei allen Vorlagen verwendet werden.
-
 
+
-
Diese Vorlage sollte bei allen Vorlagen Verwendung finden.
+
== Begründung ==
== Begründung ==
-
Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.
+
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>&lt;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. Somit ermöglicht man die Nutzung von mehr Vorlagen pro Artikelseite.
-
 
+
-
Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird. Die Wikipedia setzt die Vorlagen nicht effizient in Bytecode um. Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Nichtsdestotrotz werden <code>&lt;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.
+
== Benutzung ==
== Benutzung ==
-
Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/noinclude></code> an den Anfang einer Vorlage schreibst und die entsprechende Dokumentationsseite erstellst. Diese sollte in einem <code>&lt;includeonly></code>-Abschnitt auch die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die [[Hilfe:Kategorie|Kategorien]] und [[Hilfe:Internationalisierung|Interwikilinks]].
+
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Eine Unterseite namens <code>/Meta</code> kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt [[#Besonderheiten|Besonderheiten]] lesen), ansonsten können diese mit in die noinclude-[[Tag (Informatik)|tags]] am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikilinks]]. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).
 +
In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher
 +
: '''/Doku''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
 +
<!--: '''/Meta''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki>&lt;/noinclude>&lt;includeonly> … Meta … &lt;/includeonly></code>-->
 +
: '''/Test''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
 +
<!--: '''/Wartung''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
 +
: '''/Druck''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Druckversion|Dokumentation/Druckversion]]<nowiki>}}</nowiki>&lt;/noinclude></code>
 +
-->
== Besonderheiten ==
== Besonderheiten ==
-
Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung (Unterseite ''<code>/XML</code>'') für den [[Benutzer:Revvar/VM|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben (→ [[Vorlage:XML-Hinweis|XML-Hinweis]]). Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] (Unterseite ''<code>/Wartung</code>'') für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ [[Vorlage:Wartungshinweis|Wartungshinweis]]).
+
Wenn sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet, werden die Metadaten nicht eingebunden und weder die Vorlage, noch die Unterseite, werden in Kategorien einsortiert.
-
<includeonly>
+
 
-
[[Kategorie:Vorlage:für Vorlagen|Dokumentation]]
+
=== Unterseiten ===
-
[[Kategorie:Vorlage:nur Dokumentation|!]]
+
<!--
 +
; <code>/Meta</code>
 +
: Eine solche Unterseite ist vor allem für [[Wikipedia:Geschützte Seiten|vollgesperrte Seiten]] gedacht, die ansonsten nicht interwikifiziert werden könnten.
 +
; <code>/XML</code>
 +
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Wikipedia:Helferlein/Vorlagen-Meister|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben.
 +
; <code>/Wartung</code>
 +
: Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.-->
 +
; <code>/Test</code>
 +
: Ein Hinweis wird auch für Testunterseiten ausgegeben.
 +
<!--; <code>/Druck</code>
 +
: Eine spezielle Version der Vorlage, die zusammen mit der [[Hilfe:Buchfunktion|Buchfunktion]] benutzt wird.
 +
-->
 +
== Unterseiten anlegen ==
-
[[en:Template:Documentation]]
+
{| cellspacing="8" cellpadding="0" class="rahmenfarbe1 centered" style="font-size: 100%; border-style: solid; margin-top: 2px; margin-bottom: 2px; background-color: #eeeeff;"
-
[[eo:Ŝablono:Dok]]
+
|-
-
[[es:Plantilla:Uso de plantilla]]
+
|
-
[[fr:Modèle:Documentation modèle]]
+
<inputbox>
-
[[hsb:Předłoha:Doc]]
+
type=create
-
[[hu:Sablon:Sablondokumentáció]]
+
default=Vorlage:<Name der Vorlage>/Doku
-
[[ko:틀:틀 설명문서]]
+
buttonlabel=Dokumentationsseite anlegen
-
[[nl:Sjabloon:Sjabdoc]]
+
preload=Vorlage:Dokumentation/preload-doku
-
[[ru:Шаблон:Doc]]
+
editintro=Vorlage:Dokumentation/intro-doku
-
[[sl:Predloga:Dokumentacija]]
+
bgcolor=#eeeeff
-
[[uk:Шаблон:Doc]]
+
break=no
-
[[zh:Template:Template doc]]
+
</inputbox>
-
</includeonly><noinclude>
+
<!--<inputbox>
-
[[Kategorie:Vorlage:nur Dokumentation|Dokumentation]]
+
type=create
 +
default=Vorlage:<Name der Vorlage>/Meta
 +
buttonlabel=Metadatenseite anlegen
 +
preload=Vorlage:Dokumentation/preload-meta
 +
editintro=Vorlage:Dokumentation/intro-meta
 +
bgcolor=#eeeeff
 +
break=no
 +
</inputbox>-->
 +
<inputbox>
 +
type=create
 +
default=Vorlage:<Name der Vorlage>/Test
 +
buttonlabel=Test- und Beispielseite anlegen
 +
preload=Vorlage:Dokumentation/preload-test
 +
editintro=Vorlage:Dokumentation/intro-test
 +
bgcolor=#eeeeff
 +
break=no
 +
</inputbox>
 +
<!--<inputbox>
 +
type=create
 +
default=Vorlage:<Name der Vorlage>/Wartung
 +
buttonlabel=Wartungsseite anlegen
 +
preload=Vorlage:Dokumentation/preload-wartung
 +
editintro=Vorlage:Dokumentation/intro-wartung
 +
bgcolor=#eeeeff
 +
break=no
 +
</inputbox>
 +
<inputbox>
 +
type=create
 +
default=Vorlage:<Name der Vorlage>/Druck
 +
buttonlabel=Druckversion anlegen
 +
preload=Vorlage:Dokumentation/preload-druck
 +
editintro=Vorlage:Dokumentation/druck-wartung
 +
bgcolor=#eeeeff
 +
break=no
 +
</inputbox>-->
 +
|}
-
[[en:Template:Documentation/doc]]
+
Wenn man seine [[Spezial:MyPage/monobook.css|monobook.css]] um <source enclose="div" lang="css">.metadata { display:block !important; }</source> erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen der Unterseiten angezeigt.
-
</noinclude>
+

Aktuelle Version vom 17:40, 27. Apr. 2010

Datei:Information icon.svg Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation.

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

Wenn man seine monobook.css um

.metadata { display:block !important; }

erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen der Unterseiten angezeigt.

Von „http://de.kitakujo.de/w/index.php?title=Vorlage:Dokumentation/Doku“
Persönliche Werkzeuge