* New pagestats plugin from Enrico, which can generate a table counting

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

diff --git a/doc/plugins/pagestats.mdwn b/doc/plugins/pagestats.mdwn
new file mode 100644 (file)
index 0000000..41c853b
--- /dev/null
+++ b/doc/plugins/pagestats.mdwn
@@ -0,0 +1,13 @@
+This plugin can generate stats about how pages link to each other. It can
+produce either a del.icio.us style cloud, or a table counting the number of
+links to each page.
+
+Here's how to use it to create a [[tag]] cloud:
+
+       \[[pagestats pages="tags/*"]]
+
+And here's how to create a table of all the pages on the wiki:
+
+       \[[pagestats style="table"]]
+
+This plugin is included in ikiwiki, but is not enabled by default.