aboutsummaryrefslogtreecommitdiff
path: root/underlays/basewiki/directive/pagestats.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'underlays/basewiki/directive/pagestats.mdwn')
-rw-r--r--underlays/basewiki/directive/pagestats.mdwn13
1 files changed, 13 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/pagestats.mdwn b/underlays/basewiki/directive/pagestats.mdwn
new file mode 100644
index 000000000..c6888df37
--- /dev/null
+++ b/underlays/basewiki/directive/pagestats.mdwn
@@ -0,0 +1,13 @@
+The `pagestats` directive is supplied by the [[!iki plugins/pagestats]] plugin.
+
+This directive 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"]]