Vorlage:Vorlage/Doku: Unterschied zwischen den Versionen
K (Bot: ---- \n <noinclude>{{DatenAusWikipedia}}</noinclude> hinzugefügt) |
Peter (Diskussion | Beiträge) K (Änderungen von Peters bot (Diskussion) wurden auf die letzte Version von Peter zurückgesetzt) |
||
Zeile 38: | Zeile 38: | ||
| {{Vorlage|Unterschreiben|subst=true, ja oder sonstwas}} | | {{Vorlage|Unterschreiben|subst=true, ja oder sonstwas}} | ||
|} | |} | ||
Version vom 19. April 2012, 21:44 Uhr
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.
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>
- /Meta
<noinclude>{{Dokumentation/Metaseite}}</noinclude><includeonly> … Meta … </includeonly>
- /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>
- /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>
- /Druck
<noinclude>{{Dokumentation/Druckversion}}</noinclude>
- /Editnotice
<noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>
- /Unterseite
<noinclude>{{Dokumentation/Unterseite}}</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
/Meta
- Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.
/XML
- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
/Wartung
- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
/Test
- Ein Hinweis wird auch für Testunterseiten ausgegeben.
/Druck
- Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
/Editnotice
- Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.
Unterseiten anlegen
<inputbox> type=create default=Vorlage:<Name der Vorlage>/Doku buttonlabel=Dokumentationsseite anlegen preload=Vorlage:Dokumentation/preload-doku editintro=Vorlage:Dokumentation/intro-doku break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Meta buttonlabel=Metadatenseite anlegen preload=Vorlage:Dokumentation/preload-meta editintro=Vorlage:Dokumentation/intro-meta 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 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 break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Druck buttonlabel=Druckversion anlegen preload=Vorlage:Dokumentation/preload-druck editintro=Vorlage:Dokumentation/intro-druck break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Editnotice buttonlabel=Editnotice anlegen preload=Vorlage:Dokumentation/preload-editnotice editintro=Vorlage:Dokumentation/intro-editnotice break=no </inputbox> |
Wenn man das MediaWiki:Gadget-Personendaten in den Einstellungen aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.
Vorlagenverwendung
Mit dieser Vorlage wird der Quelltext (Wiki-Code) zum Einbinden einer Vorlage so angezeigt, wie er in der MediaWiki-Software verwendet wird. Als ein mehr intuitives Hilfsmittel zur benutzerfreundlicheren Verwendung, ist sie im Prinzip gleichbedeutend mit dieser Wiki-Syntax: {{[[Vorlage:Name der Vorlage|]]}}
Zum Verlinken von Commons-Vorlagen verwende Vorlage:Commonsvorlage.
Vorlagencode | Erklärung | Ergebnis |
---|---|---|
{{Vorlage|Name der Vorlage}}
|
Für den Normalfall, d. h. für eine Vorlage, die im Vorlagen-Namensraum abgelegt ist. Als Name der Vorlage kann der Teil hinter Vorlage: weggelassen werden. | {{Hallo}}
|
{{Vorlage|Name der Vorlage|Parameter für die verlinkte Vorlage}}
|
Zusätzlich können Parameter angegeben werden. Diese Parameter sind nicht für die Vorlage:Vorlage sondern für die verlinkte Vorlage vorgesehen. Es können bis zu 10 Parameter angegeben werden. | {{Löschen|deine Begründung --~~~~}}
|
{{Vorlage|Name der Vorlage außerhalb des Vorlagen-Namensraums}}
|
Wenn die Vorlage nicht im Vorlagen-Namensraum, sondern z. B. im Benutzer-Namensraum liegt, kann diese ebenfalls auf dieselbe Weise benutzt werden. | {{Benutzer:Church of emacs/geSLAt}}
|
{{Vorlage|Name der Vorlage außerhalb des Vorlagen-Namensraums|Parameter}}
|
Fall 2 und 3 lassen sich auch kombinieren, indem man auch hier danach die Parameter angibt. | {{Benutzer:Church of emacs/geSLAt|wwni}}
|
{{Vorlage|:Seite im Artikelsnamensraum}}
|
Falls die Seite im Artikelsnamensraum liegt, muss genau wie in der Software ein Doppelpunkt davor gesetzt werden. Auch Parameter können hier verwendet werden. | {{:Deutschland}}
|
{{Vorlage|Kategorie oder Datei}}
|
Im Gegensatz zu normalen Links erfordert eine Vorlage für eine Einbindung einer Kategorie- oder Dateibeschreibungsseite keinen Doppelpunkt, entsprechend erfordert die Vorlage auch keinen. | {{Kategorie:!Hauptkategorie}}
|
{{Vorlage|Name der Vorlage|subst=irgendwas}}
|
Wenn der Parameter subst einen Wert hat, wird die Substitutionsanweisung mitangegeben. Er kann mit den anderen Möglichkeiten kombiniert werden. | {{subst:Unterschreiben}}
|