summaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive/pagestats.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
commit9921a4a8a1a696ce69acce5e14943f0149d926ff (patch)
tree926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/pagestats.mdwn
parent7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff)
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/pagestats.mdwn')
-rw-r--r--doc/ikiwiki/directive/pagestats.mdwn15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/pagestats.mdwn b/doc/ikiwiki/directive/pagestats.mdwn
new file mode 100644
index 000000000..de0419a03
--- /dev/null
+++ b/doc/ikiwiki/directive/pagestats.mdwn
@@ -0,0 +1,15 @@
+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 tag 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"]]
+
+[[!meta robots="noindex, follow"]]