Migrate escaped directives (\[[) in doc/plugins to have \[[! prefix

[ikiwiki.git] / doc / plugins / postsparkline.mdwn

diff --git a/doc/plugins/postsparkline.mdwn b/doc/plugins/postsparkline.mdwn
index da2e6830e83923547152da4c64b24bd3da1e12df..73c6801a13e57d37a67f1c2f01500e85d46132f4 100644 (file)
--- a/doc/plugins/postsparkline.mdwn
+++ b/doc/plugins/postsparkline.mdwn
@@ -1,5 +1,5 @@
-[[template id=plugin name=postsparkline author="[[Joey]]"]]
-[[tag type/chrome]]
+[[!template id=plugin name=postsparkline author="[[Joey]]"]]
+[[!tag type/chrome]]
 
 This plugin uses the [[sparkline]] plugin to create a sparkline of
 statistics about a set of pages, such as posts to a blog.
@@ -7,22 +7,22 @@ statistics about a set of pages, such as posts to a blog.
 # examples
 
        Post interval: 
-       \[[postsparkline pages="blog/* and !*/Discussion" max=100
+       \[[!postsparkline pages="blog/* and !*/Discussion" max=100
        formula=interval style=bar barwidth=2 barspacing=1 height=13]]
        
        Posts per month this year: 
-       \[[postsparkline pages="blog/* and !*/Discussion" max=12
+       \[[!postsparkline pages="blog/* and !*/Discussion" max=12
        formula=permonth style=bar barwidth=2 barspacing=1 height=13]]
 
 # usage
 
-All options aside fron the `pages`, `max`, `formula`, and `time` options
-are passed on to the sparkline plugin.
+All options aside fron the `pages`, `max`, `formula`, `time`, and `color`
+options are passed on to the sparkline plugin.
 
 You don't need to specify any data points (though you can if you want to).
 Instead, data points are automatically generated based on the creation
-times of pages matched by the specified `pages` [[PageSpec]]. A maximum of
-`max` data points will be generated.
+times of pages matched by the specified `pages` [[ikiwiki/PageSpec]]. A
+maximum of `max` data points will be generated.
 
 The `formula` parameter controls the formula used to generate data points.
 Available forumlae:
@@ -40,6 +40,9 @@ The `time` parameter has a default value of "ctime", since forumae use
 the creation times of pages by default. If you instead want
 them to use the modification times of pages, set it to "mtime".
 
+To change the color used to draw the sparkline, use the `color` parameter.
+For example, "color=red".
+
 # adding formulae
 
 Additional formulae can be added without modifying this plugin by writing