Vorlage:Vorlagendokumentation Land mit Flagge/Doku

Aus zechenkarte
< Vorlage:Vorlagendokumentation Land mit Flagge
Version vom 22. März 2012, 13:37 Uhr von Peter (Diskussion | Beiträge) (1 Version: Import aus der deutschen Wikipedia)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen
Abkürzung: WP:FLA

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.


Hinweise

Bevor du diese Vorlage (eine von über 1000) änderst, bitte Folgendes beachten:

Verwendung

  • Die Vorlagen werden einfach mit {{XYZ}} eingebunden, wobei XYZ entweder dem dreistelligen Länderkürzel der ISO-3166-Kodierung (ISO) oder dem Kürzel des Internationalen Olympischen Komitees (IOC) entspricht. Die IOC-Vorlagen sind Weiterleitungen auf die entsprechenden ISO-Vorlagen (um den Pflegeaufwand zu minimieren).
    Beispiel: {{DEU}} wird zu DeutschlandDeutschland Deutschland
  • Zur Änderung des Link-Ziels kann ein zusätzlicher (also optionaler) Parameter angegeben werden. Das Linkziel muss ohne [[…]] angegeben werden.
    Beispiel: {{DEU|Deutsche Fußballnationalmannschaft}} wird zu DeutschlandDeutschland Deutschland.
  • Zur Änderung des Link-Textes kann ein weiterer zusätzlicher (also optionaler) Parameter angegeben werden. Der Link-Text muss ohne [[…]] angegeben werden.
    Beispiel: {{DEU|Deutsche Fußballnationalmannschaft|Fußball in Deutschland}} wird zu DeutschlandDeutschland Fußball in Deutschland
  • Soll nur der Link-Text geändert werden, kann der zweite unbenannte Parameter direkt angegeben werden.
    Hier lassen sich auch die Länderkürzel verwenden. Der entstehende Link führt zum Länderartikel.
    Beispiel 1: {{DEU|2=Bundesrepublik Deutschland}} wird zu DeutschlandDeutschland Bundesrepublik Deutschland
    Beispiel 2: {{DEU|2=GER}} wird zu DeutschlandDeutschland GER
  • Soll kein Link-Ziel und -Text ausgegeben werden, muss # eingetragen werden.
  1. Beispiel: {{DEU|#}} wird zu DeutschlandDeutschland
  • Zur Änderung der Flaggengröße kann der optionale benannte Parameter WIDTH angegeben werden, der als Pixelwert (px) interpretiert wird. Ohne Angabe dieses Parameters wird einheitlich 20px benutzt (Hinweis: Die schmalen Flaggen von Belgien, Nepal und Schweiz haben einen zusätzlichen Rand, der zur einheitlichen Texteinrückung in Listen ein Seitenverhältnis von 4:3 simuliert).
    Beispiel: {{DEU|WIDTH=40}} wird zu DeutschlandDeutschland Deutschland.
Abgerufen von „http://www.zechenkarte.de/wiki/index.php?title=Vorlage:Vorlagendokumentation_Land_mit_Flagge/Doku&oldid=260“