Vorlage:Farbindex/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Farbindex.

Übrigens: Die PlusPedia ist NICHT die Wikipedia. Wir sind ein gemeinnütziger Verein, PlusPedia ist werbefrei. Wir freuen uns daher über eine kleine Spende!

1 Verwendung

Diese Vorlage zeichnet ein kleines Kästchen mit einem Farbhintergrund und einen nebenstehenden Text. Damit können beispielsweise Legenden für Kartenbilder (als Bildunterschrift), Statistiken oder Tabellen gestaltet werden.

2 Parameter

Parameter	Pflichtfeld	Beschreibung	Standardwert	Hinweis
1		Welcher Farbton soll dargestellt werden?	black	Gültige Angaben sind Hex-Werte, wobei die führende Raute (#) nicht angegeben werden darf. Weiterhin gültige Angaben sind HTML-Farbnamen oder transparent, wobei im 3. Parameter der Wert name anzugeben ist.
2		Welcher erklärende Text soll neben dem Farbwert erscheinen?		Wird der Wert hex angegeben, so wird der Text aus dem Zeichen #<code> sowie dem Wert aus Parameter 1 zusammengesetzt.
3		Wie ist der Farbton im 1. Parameter angegeben worden?		Wird dieser Parameter leer gelassen, wird der 1. Parameter als Hex-Wert interpretiert. Wird der 3. Parameter mit dem Wert <code>name gefüllt, so wird der 1. Parameter als HTML-Farbname interpretiert.

2.1 Erweiterung s

Eine andere Ausgabe erfolgt wenn im 2. Parameter der Buchstabe "s" angegeben ist; in diesem Fall wird ein kleines ungerahmtes Quadrat gezeichnet in der Farbe, deren hex-Triplet (ohne "#") im 1. Parameter spezifiziert ist; zusätzlich kann im 3. Parameter ein px-Wert angegeben werden, bei fehlender Angabe gilt 8px.

2.2 Erweiterung h

Wenn im 2. Parameter der Buchstabe "h" angegeben ist, werden die vordefinierten Hintergrundfarben verwendet. Diese Farben sind nicht fest, sondern werden dem Erscheinungsbild einer Oberfläche (Skin) entsprechend festgelegt, werden also ausschliesslich vom Benutzer gewählt. Farbkodierung mit einer Bedeutung (etwa in der Voreinstellung 7 rötlich als „nein“ und 9 grünlich als „ja“) ist also unverlässlich.

Im ersten Parameter steht die Nummer, im 2. "h", im 3. etwas Beliebiges, damit auch der Text erscheint.

3 Beispiele

Anwendungsfall	Eingabe	Ausgabe
Farbangabe als Hex-Wert	{{Farbindex|ABCDEF|Text}}	 Text
Farbangabe als HTML-Farbname	{{Farbindex|blue|Text|name}}	 Text
Verzicht auf optionalen Beschreibungstext	{{Farbindex|transparent||name}}	
Ist der Text hex, wird stattdessen der hexadezimale Farbwert als Text ausgegeben.	{{Farbindex|ABCDEF|hex}}	 #ABCDEF
Angabe mehrerer Farbwerte: Diese Vorlage eignet sich auch für Fließtext. Ein etwaiger Zeilenumbruch muss selbst erzeugt werden, oder es wird auf die Vorlage:Farblegende zurückgegriffen.	{{Farbindex|FF0000}} {{Farbindex|FFFF00|warme Farbtöne}},<br />{{Farbindex|00FF00}} {{Farbindex|0000FF|kalte Farbtöne}}	  warme Farbtöne,   kalte Farbtöne
Mit der Vorlage können folglich auch mehrere Farben gemeinsam gesetzt werden.	{{Farbindex |def}}{{Farbindex |Aqua|3=name}}{{Farbindex |#1C86ee|3 Kästchen|name}}	 3 Kästchen
Parameter 2 = "s"	{{Farbindex|FF0|s}} {{Farbindex|F90|s}} {{Farbindex|600|s}} und {{Farbindex|2=s}}	! ! ! und !
	{{Farbindex|02AB03|s|36}} {{Farbindex|000|s|4}}{{Farbindex|000|s|4}}{{Farbindex|000|s|4}}{{Farbindex|000|s|4}} {{Farbindex|F0F|s|18}}{{Farbindex|F0F|s|18}}	! !!!! !!
Parameter 2 = "h"	{{Farbindex|5|h}} {{Farbindex|4|h}}	!  !
	{{Farbindex|7|h|text}}	Hintergrundfarbe7!

Tooltip-Funktion

Die verwendete Farbe kann angezeigt werden, wenn der Mauszeiger auf das Kästchen weist. Hex-Werte werden in Großbuchstaben angezeigt, Farbnamen hingegen wie geschrieben.