Vorlage:Dokumentation

Aus Kitakien

(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Knappere Formulierung für die Meta-Unterseite ohne Anzeige des etwas kryptischen Seitennamens)
(Ergänzung, interwiki)
 
(Der Versionsvergleich bezieht 86 dazwischenliegende Versionen mit ein.)
Zeile 1: Zeile 1:
-
<div class="rahmenfarbe1" style="margin-bottom:0.5em; padding:0.5em; padding-top:0; clear:both; border-style:solid;" id="Vorlage_Dokumentation">
+
<noinclude>{{Tausendfach verwendet}}
-
{{Überschriftensimulation 1|Dokumentation}}
+
{{dok|nr=10}}
-
{{#ifexist: {{SUBJECTPAGENAME}}/Doku|
+
[[Kategorie:Kitakien:Hilfsvorlagen]]</noinclude><includeonly>{{#ifeq:{{NAMESPACE}}|{{ns:0}}|<strong class="error">Achtung: Die [[Vorlage:Dokumentation]] wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt<code>&lt;noinclude&gt;</code> in einer eingebundenen Vorlage oder die Kapselung ist fehlerhaft. Bitte{{Bearbeiten|text=entferne diesen Fehler}}.</strong>|
-
{{(!}} cellspacing="8" cellpadding="0" class="hintergrundfarbe1 rahmenfarbe1 plainlinks" style="font-size:90%; border-style:solid; margin: 2px 0;"
+
{{#if:{{{dok|}}}|{{Dokumentation/Anfang|{{{dok}}}|oberer Rand={{{oberer Rand|}}}|notoc={{{notoc|}}}}}{{{{{dok}}}}}{{#if:{{{nr|}}}|{{Dokumentation/Ende|nr={{{nr}}}|dok={{{dok}}}}}|{{Dokumentation/Ende|dok={{{dok}}}}}}}
-
{{!}} style="position:relative; width:35px; vertical-align:middle;" {{!}} {{Imagemap
+
|{{Dokumentation/Anfang|oberer Rand={{{oberer Rand|}}}|{{SUBJECTPAGENAME}}/Doku|notoc={{{notoc|}}}}}{{#ifexist:{{SUBJECTPAGENAME}}/Doku|{{{{SUBJECTPAGENAME}}/Doku}}|{{Dokumentation fehlt|1={{{dok|}}}}}}}{{#if:{{{nr|}}}|{{Dokumentation/Ende|nr={{{nr}}}}}|{{Dokumentation/Ende}}}}}}
-
|Bild = Information icon.svg
+
}}</includeonly><noinclude>
-
|Maße = 30px
+
[[eo:Ŝablono:Dok]]
-
|Ziel = Spezial:Präfixindex/{{SUBJECTPAGENAME}}/
+
[[hsb:Předłoha:Dokumentacija]]
-
|Alt = Information
+
</noinclude>
-
|Titel = Liste der Unterseiten
+
-
|Beschreibung = keine
+
-
}}
+
-
{{!}} style="width: 100%;" {{!}}
+
-
*Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]].{{#ifexist:{{SUBJECTPAGENAME}}/Wartung|
+
-
*Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen.
+
-
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML|
+
-
*Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]].
+
-
}}{{#ifexist:{{SUBJECTPAGENAME}}/Test|
+
-
*Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]].
+
-
}}{{#ifexist: {{SUBJECTPAGENAME}}/Meta|
+
-
*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]]}} ([{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit}} bearbeiten]).}}
+
-
{{!)}}
+
-
{{{{SUBJECTPAGENAME}}/Doku}}
+
-
|<span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]</span>}}
+
-
<div style="clear:both;"></div>
+
-
</div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}}}}}
+

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

Datei:Zeichen 206.svg Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Bitte berücksichtige den aktuellen Stand der Auftragswarteschlange.
Datei:Information.svg 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.
Wenn du Fragen zu dieser Vorlage hast, dann kannst du auf der Seite Kitakien Diskussion:Wikiprojekt Vorlage fragen.
Von „http://de.kitakujo.de/w/index.php?title=Vorlage:Dokumentation“
Persönliche Werkzeuge
Andere Sprachen