summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/sparkline.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:27 +0200
committerJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:27 +0200
commit46d295eff558e247b05e61038bd82d5c5b8155a7 (patch)
tree13d82b647d5fb5e7f67ba4e7fde9f9206acce302 /ikiwiki/directive/sparkline.mdwn
Sync with ikiwiki 3.20100926.HEADmasterikiwiki
Diffstat (limited to 'ikiwiki/directive/sparkline.mdwn')
-rw-r--r--ikiwiki/directive/sparkline.mdwn59
1 files changed, 59 insertions, 0 deletions
diff --git a/ikiwiki/directive/sparkline.mdwn b/ikiwiki/directive/sparkline.mdwn
new file mode 100644
index 0000000..6440168
--- /dev/null
+++ b/ikiwiki/directive/sparkline.mdwn
@@ -0,0 +1,59 @@
+Die `sparkline`-Anweisung wird durch die [[!iki plugins/sparkline
+desc=sparkline]]-Erweiterung bereitgestellt.
+
+Diese Anweisung erlaubt es, sparklines in Wiki-Seiten einzubetten. Eine
+sparkline ist eine kleine Graphik, die so groß wie ein Wort ist und sich
+deshalb zur Anzeige neben Text eignet.
+
+# Beispiele
+
+ \[[!sparkline 1 3 5 -3 10 0 width=40 height=16
+ featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]]
+
+Dies erzeugt eine einfache Liniengrafik, die aus mehreren Punkten
+besteht. Sie wird mit 40 Pixel Breite und 16 Pixel Höhe erzeugt. Der hohe
+Punkt auf der Linie hat eine grüne Markierung, der niedrige eine rote.
+
+ \[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2
+ barspacing=1 height=13]]
+
+Dies ist ein komplexeres Beispiel, das eine Balkengrafik erzeugt. Die Balken
+sind 2 Pixel breit und werden durch ein Pixel getrennt; die Grafik ist 14
+Pixel hoch. Die Breite für Balkengrafiken automatisch bestimmt. Punkte mit
+negativen Werten haben abweichend vom voreingestellten Schwarz die Farbe
+rot.
+
+# Verwendung
+
+Die Form für Datenpunkte ist `x,y`, oder einfach nur `y`, wenn die x-Werte
+unerheblich sind. Balkengrafiken können auch `(color)` hinzufügen, um eine
+Farbe für den Balken anzugeben.
+
+Die folgenden benannten Parameter werden erkannt. Die meisten entsprechen
+denen der zugrundeliegenden sparkline-Bibliothek, die [in ihrem
+Wiki](http://sparkline.wikispaces.com/usage) genauer beschrieben wird.
+
+* `style` - Entweder `line` (die Voreinstellung) oder `bar`.
+* `width` - Die Breite der Grafik in Pixeln. Wird nur für Linien-Grafiken
+ benötigt.
+* `height` - Höhe des Grafen in Pixeln. Voreingestellt sind 16.
+* `barwidth` - Breite der Balken in einer Balkengrafik. Voreingestellt ist 1
+ Pixel.
+* `barspacing` - Abstand zwischen den Balken einer Balkengrafik in
+ Pixeln. Voreingestellt ist 1 Pixel.
+* `ymin`, `ymax` - Minimaler und maximaler Wert für die y-Achse. Dies wird
+ normalerweise automatisch berechnet, kann aber auch explizit angegeben
+ werden, um mehrere verwandte Grafiken zu erhalten.
+* `featurepoint` - Fügt eine kreisförmige Markierung zu einer Liniengrafik
+ hinzu, mit optionalem Text. So können bedeutsame Punkte beschriftet
+ werden.
+
+ Der Wert ist eine Komma-separierte Liste von Parametern, die den
+ hervorzuhebenden Punkt angeben: x-Wert, y-Wert, Farbname,
+ Kreisdurchmesser, Text (optional) und Platzierung des Textes (optional).
+ Beispiel: `featurepoint="3,5,blue,3"`
+
+ Verfügbare Werte für die Platzierung des Textes sind `top`,
+ `right`, `bottom` und `left`.
+
+[[!meta robots="noindex, follow"]]