summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/postsparkline.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/postsparkline.mdwn')
-rw-r--r--ikiwiki/directive/postsparkline.mdwn47
1 files changed, 47 insertions, 0 deletions
diff --git a/ikiwiki/directive/postsparkline.mdwn b/ikiwiki/directive/postsparkline.mdwn
new file mode 100644
index 0000000..1f475f5
--- /dev/null
+++ b/ikiwiki/directive/postsparkline.mdwn
@@ -0,0 +1,47 @@
+Die `postsparkline`-Anweisung wird durch die [[!iki plugins/postsparkline
+desc=postsparkline]]-Erweiterung bereitgestellt.
+
+Diese Anweisung verwendet die [[!iki plugins/sparkline
+desc=sparkline]]-Erweiterung, um eine [[sparkline]] mit Statistiken über
+bestimmte Seiten anzuzeigen, etwa über Einträge in einem Blog.
+
+# Beispiele
+
+ Intervall der Einträge:
+ \[[!postsparkline pages="blog/* and !*/Discussion" max=100
+ formula=interval style=bar barwidth=2 barspacing=1 height=13]]
+
+ Einträge pro Monat in diesem Jahr:
+ \[[!postsparkline pages="blog/* and !*/Discussion" max=12
+ formula=permonth style=bar barwidth=2 barspacing=1 height=13]]
+
+# Verwendung
+
+Alle Parameter außer `pages`, `max`, `formula`, `time` und `color` sind die
+gleichen wie in der [[sparkline]]-Anweisung.
+
+Es müssen keine Datenpunkte angegeben werden (auch wenn dies möglich
+ist). Stattdessen werden die Datenpunkte ausgehend vom Erstellungsdatum der
+durch `pages` angegebenen Seiten (eine [[ikiwiki/PageSpec]]) automatisch
+generiert. Es werden höchstens `max` Datenpunkte erzeugt.
+
+Der Parameter `formula` steuert die Formel, mit der die Datenpunkte erzeugt
+werden. Verfügbare Formeln:
+
+* `interval` - Die Höhe jedes Punkts steht für den zeitlichen Abstand zum
+ vorherigen Eintrag.
+* `perday` - Jeder Punkt entspricht einem Tag; die Höhe stellt die Anzahl
+ der an diesem Tag gemachten Einträge dar.
+* `permonth` - Jeder Punkt entspricht einem Monat; die Höhe stellt die
+ Anzahl der in diesem Monat gemachten Einträge dar.
+* `peryear` - Jeder Punkt entspricht einem Jahr; die Höhe stellt die Anzahl
+ der in diesem Jahr gemachten Einträge dar.
+
+Der Parameter `time` hat standardmäßig den Wert `ctime` und es werden die
+Erstellungszeiten der Seiten verwendet. Sollen stattdessen die
+Änderungszeiten verwendet werden, kann `mtime` angegeben werden.
+
+Die Farbe der sparkline kann mit dem Parameter `color` verändert werden,
+etwa durch `color=red`.
+
+[[!meta robots="noindex, follow"]]