Vorlage:Farbindex/Doku

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

TemplateData

Legende für Farbwert: kleines Kästchen (inkl. Rahmen 18 Pixel breit, 21 Pixel hoch) mit einem Farbhintergrund und nebenstehender Text.
Damit können beispielsweise Legenden für Kartenbilder (als Bildunterschrift) oder Tabellen gestaltet werden.
Wenn der Text zum Farbkästchen innerhalb der Vorlage angegeben ist, wird ein Tooltip generiert, außerdem wird zwischen Kästchen und Text der Umbruch verhindert.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
Farbton	1	Legt den Farbton fest. Hierfür können unterschiedliche Farbformate benutzt werden:   Beispiel 8B0000 <-- Hexcode im Format „RRGGBB“ (ohne führendes „#“)   Beispiel bbb <-- Hexcode im Format „RGB“ (ohne führendes „#“)   Beispiel red <-- HTML-Farbnamen, falls Parameter 3=name   Beispiel transparent <-- transparentes Farbkästchen, falls Parameter 3=name   Beispiel 1 bis 9 <-- Hintergrundfarben von Cowboy’s Wiki, falls Paramter 2=h   Standard 000000 (schwarz)	Zeile	vorgeschlagen
Legende + Sonderfunktionen	2	Erklärender Text, der hinter Kästchen erscheint:   Beispiel Blau bedeutet Wasser --> dieser Text erscheint hinter dem Kästchen   wenn hex --> dann wird einen erklärenden Text aus „#“ + Parameter 1 generiert, sprich: hinter dem Kästchen wird dessen Farbcode angezeigt Sonderfunktion „Erweiterung s“   wenn s (für „small“) --> dann wird statt eines standardmäßigen Kästchens (18x21 Pixel mit Rahmen) ein kleineres ungerahmtes Quadrat mit 8x8 Pixeln dargestellt. Im Paramter 3 kann dann die Pixelgröße angegeben werden. Sonderfunktion „Erweiterung h“   wenn h (für „hintergrundfarbe“) --> dann kann bei Parameter 1 die Nummer der vordefinierten Hintergrundfarben von Cowboy’s Wiki verwendet werden	Zeile	optional
Farbformat	3	Legt Farbformat für Parameter 1 fest   wenn name --> dann kann für Parameter 1 der HTML-Farbname verwendet werden   Standard 1 bedeutet Hexcode für Parameter 1 Legt Größe des Farbkästchens in Pixeln fest (als Quadrat), wenn Parameter 2=s. Eine weitere Voraussetzung: Die Farbe des Kästchens (Parameter 1) muss im Hex-Format angegeben sein, HTML-Farbnamen funktionieren in dieser Kombination nicht!   Beispiel 12 --> ein ungerahmtes Quadrat mit 12x12 Pixeln wird dargestellt	Zeile	optional
Tooltip	Tooltip	Vorgegebener statt generiertem Tooltip   Beispiel Das sieht richtig schwarz aus --> dieser Text wird angezeigt, wenn man das Kästchen mit der Maus überfährt   Standard Farbwert gemäß Parameter 1	Zeile	optional
Rahmenfarbe	5	Legt die Rahmenfarbe des Farbkästchen fest. Hierfür können unterschiedliche Farbformate benutzt werden:   Beispiel FF0000 (rot) <-- Hexcode im Format „RRGGBB“ (ohne führendes „#“)   Beispiel F00 (rot) <-- Hexcode im Format „RGB“ (ohne führendes „#“)   wenn g (für „grau“) --> dann bekommt das Kästchen das gleiche helle Grau als Rahmenfarbe, wie jenes der wikitables (entspricht der Farbe #A2A9B1)   Standard FFFFFF (schwarz)	Zeile	optional

Format: inline

Sonderfunktionen

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.

Erweiterung h

Wenn im 2. Parameter der Buchstabe „h“ angegeben ist, werden die in Cowboy’s Wiki vordefinierten Hintergrundfarben illustriert. Diese Farben sind nicht fest, sondern werden dem Erscheinungsbild einer Oberfläche (Skin) entsprechend festgelegt, werden also ausschließlich 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.

Beispiele

Anwendungsfall	Eingabe		Ausgabe
	Rahmenfarbe Standard	Rahmenfarbe individuell	Rahmenf. Standard	Rahmenf. individuell
Farbangabe als Hex-Wert	{{Farbindex|ABCDEF|Text}}	{{Farbindex|ABCDEF|Text|5=g}}	Text	Text
Farbangabe als HTML-Farbname	{{Farbindex|LightBlue|Text|name}}	{{Farbindex|LightBlue|Text|name||g}}	Text	Text
Verzicht auf optionalen Beschreibungstext	{{Farbindex|transparent||name}}	{{Farbindex|transparent||name|5=g}}		
Ist der Text hex, wird stattdessen der hexadezimale Farbwert als Text ausgegeben.	{{Farbindex|ABCDEF|hex}}	{{Farbindex|ABCDEF|hex|5=f00}}	 #ABCDEF	 #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|F88}} {{Farbindex|FF8|warme Töne}}, {{Farbindex|8F8}} {{Farbindex|88F|kalte Töne}}	{{Farbindex|F88|5=g}} {{Farbindex|FF8|warme Töne|5=g}}, {{Farbindex|8F8|5=g}} {{Farbindex|88F|kalte Töne|5=g}}	 warme Töne,  kalte Töne	 warme Töne,  kalte Töne
Mit der Vorlage können folglich auch mehrere Farben gemeinsam gesetzt werden.	{{Farbindex|def}}{{Farbindex|SkyBlue|3=name}}{{Farbindex|1C86ee|drei Kästchen}}	{{Farbindex|def|5=fff}}{{Farbindex|SkyBlue|3=name|5=fff}}{{Farbindex|1C86ee|drei Kästchen|5=fff}}	drei Kästchen	drei Kästchen
Parameter 2 = „s“	{{Farbindex|FF0|s}} {{Farbindex|F90|s}} {{Farbindex|600|2=s}} ein Text		! ! ! ein Text	–
	{{Farbindex|02AB03|s|36}} {{Farbindex|F0F|s|18}}{{Farbindex|F0F|s|18}} (grünes Quadrat und lila Rechteck aus 2 Quadraten) {{Farbindex|000|s|4}}{{Farbindex|FFF|s|4}}{{Farbindex|000|s|4}}{{Farbindex|FFF|s|4}}{{Farbindex|000|s|4}} ABC (gepunktet: drei kleine schwarze Quadrate nebeneinander mit je einem weißen Quadrat als Abstand dazwischen)		! !! !!!!! ABC	–
Parameter 2 = „h“	{{Farbindex|5|h}} {{Farbindex|4|h}}	{{Farbindex|5|h|5=g}} {{Farbindex|4|h|5=g}}	! !	! !
	{{Farbindex|7|h}} text	{{Farbindex|7|h|5=g}} text	! text	! text

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.

Beispiel einer Farblegende unter einer Tabelle: Vorlage:Legende Deep-Sky-Objektliste

Siehe auch

• Vorlage:Farblegende – kleine Farbkästchen, nur für Listen, da Zeilenumbruch erzwungen wird
• Vorlage:Farbmuster – große Farbkästchen, für Artikel über Farben
• Vorlage:Linienlegende – Farblegende für Linien
• Vorlage:Coltit – Farblegende eines Tabellenelements als Tooltip
• Cowboy’s Wiki:Farbe #Vorlagen – mehr zu Farbe und Vorlagen