Vorlage:Dokumentation

Aus Kitakien

(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
K (+plainlinks)
(Martin)
Zeile 16: Zeile 16:
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML|  
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML|  
<div><span>&bull; Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. </span></div>|
<div><span>&bull; Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. </span></div>|
-
<div><span class="metadata metadata-label"><span style="display:none;">[[Vorlage:Dokumentation/Wartung/keine XML-Beschreibungsseite]]</span>&bull; [[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]</div>
+
<div><spa 25041993
-
}}{{#ifexist:{{SUBJECTPAGENAME}}/Test|
+
-
<div><span>&bull; Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]. </span></div>|
+
-
<div><span class="metadata metadata-label"><span style="display:none;">[[Vorlage:Dokumentation/Wartung/keine Testseite]]</span>&bull; [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</span></div>
+
-
}}{{#ifexist: {{SUBJECTPAGENAME}}/Meta|
+
-
<div><span>&bull; 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
+
-
|werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]}}. </span></div>|
+
-
<div><span class="metadata metadata-label"><span style="display:none;">[[Vorlage:Dokumentation/Wartung/keine Metadatenseite]]</span>&bull; [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]. </span></div>}}
+
-
<div><span>&bull; [[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].
+
-
{{!)}}
+
-
|<span class="plainlinks" style="font-size:150%;">
+
-
* [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]
+
-
{{#ifexist:{{SUBJECTPAGENAME}}/Meta||
+
-
* [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}
+
-
{{#ifexist:{{SUBJECTPAGENAME}}/Test||
+
-
* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}
+
-
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung||
+
-
* [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
+
-
</span>}}
+
-
<div style="clear:both;"></div>
+
-
</div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}}}}}
+
-
}}
+

Version vom 09:05, 26. Nov. 2008

{{#ifeq:Vorlage||Achtung: Die Vorlage:Dokumentation wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt <noinclude> in einer eingebundenen Vorlage oder die Kapselung ist fehlerhaft. Bitte Vorlage:Bearbeiten.|

Datei:Information icon.svg
[Bearbeiten] Dokumentation

{{#ifexist: Vorlage:Dokumentation/Doku| 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“
Persönliche Werkzeuge