Vorlage:TitelFormat/Doku

Aus zechenkarte
Zur Navigation springen Zur Suche springen

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.

Vorlage:Tausendfach verwendet Diese Vorlage dient der Formatierung von Titelangaben innerhalb anderer Vorlagen.

Der übergebene Titel wird in Kursivschrift gesetzt und mit einem Punkt beendet, wenn dies sinnvoll ist.

Anzuwenden wäre dies etwa innerhalb von Vorlage:Literatur oder Vorlage:Internetquelle sowie diversen Vorlage:cite.

Kein Punkt wird angefügt, wenn der Titel bereits mit einem Punkt endet – oder mit Fragezeichen oder Ausrufezeichen. Dabei kann Titel auch in Anführungszeichen eingeschlossen sein oder als Link enden. Punkt, Fragezeichen oder Ausrufezeichen können für Titel in CJK auch aus den halbbreiten und vollbreiten Formen stammen: U+FF01, U+FF0E, U+FF1F.

Einbindung

  1. {{TitelFormat|T=TITEL}}
  2. ''TITEL{{TitelFormat/core|T=TITEL|L={{Str len|1=TITEL}}|M=>}}

Die zweite Form erspart eine Schachtelungsebene an eingebundenen Untervorlagen und verbessert die Performance; bei den wenigen Fällen werden geübte Vorlagenprogrammierer keine Schwierigkeiten damit haben. TITEL ist der Parameter innerhalb der einbindenden Vorlage.

Parameter

T
TITEL, auch auf Fragezeichen oder Ausrufezeichen endend, auch auf Punkt sowie Anführungszeichen und Verlinkung.
Ein leerer (fehlender) Parameter ist nicht vorgesehen.
  • Aus Effizienzgründen wird dies nicht überprüft. Bei den vorgesehenen und bekannten Verwendungen wird nur eingebunden, wenn das ohnehin bereits der Fall ist.
Schließende Leerzeichen wären unzulässig, können jedoch beim Durchreichen innerhalb von Vorlagen nicht auftreten.

Beispiele

Auszug: 

{{TitelFormat|T=Ein Titel}}
{{TitelFormat|T=Vorwärts!}}
{{TitelFormat|T=Das Buch zum Thema.}}
{{TitelFormat|T=Das Zitat «même vous, Brutus?»}}
{{TitelFormat|T=[http://example.com example.com]}}
{{TitelFormat|T=[http://example.com Wer besitzt die Domain example.com?]}}
{{TitelFormat|T=[[Is’ was, Doc?]]}}
{{TitelFormat|T=[[Hilfe:Vorlagenprogrammierung]]}}

Weitere Fälle auf der Testseite.

Programmierung

Die Hauptarbeit wird von der Untervorlage /core erledigt.

Die Performance wurde untersucht.


Der Inhalt dieser Seite oder Teile davon wurden aus der deutschen Wikipedia von der Seite Vorlage:TitelFormat/Doku kopiert. Der Autor bzw. die Autoren sind dort in der Versionsgeschichte nachzulesen. Diese Seite steht damit unter den gleichen Lizenzbestimmungen wie die Seite der Wikipedia, der Creative-Commons-Lizenz Namensnennung - Weitergabe unter gleichen Bedingungen 3.0 (unported).

Abgerufen von „http://www.zechenkarte.de/wiki/index.php?title=Vorlage:TitelFormat/Doku&oldid=8748“