path: root/ikiwiki/directive/pagestats.mdwn
diff options
authorJonas Smedegaard <>2010-10-14 13:38:43 +0200
committerJonas Smedegaard <>2010-10-14 13:38:43 +0200
commite990b132016f231ef150085597d02e2eb4883a1f (patch)
tree4220bd4d1a026353c7c6f74aa438aef9c6a10ff4 /ikiwiki/directive/pagestats.mdwn
Sync with ikiwiki 3.20100926.HEADmasterikiwiki
Diffstat (limited to 'ikiwiki/directive/pagestats.mdwn')
1 files changed, 40 insertions, 0 deletions
diff --git a/ikiwiki/directive/pagestats.mdwn b/ikiwiki/directive/pagestats.mdwn
new file mode 100644
index 0000000..d0e0e7b
--- /dev/null
+++ b/ikiwiki/directive/pagestats.mdwn
@@ -0,0 +1,40 @@
+The `pagestats` directive is supplied by the [[!iki plugins/pagestats desc=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
+Here's how to use it to create a [[tag]] cloud, with tags sized based
+on frequency of use:
+ \[[!pagestats pages="tags/*"]]
+Here's how to create a list of tags, sized by use as they would be in a
+ \[[!pagestats style="list" pages="tags/*"]]
+And here's how to create a table of all the pages on the wiki:
+ \[[!pagestats style="table"]]
+The optional `among` parameter limits the pages whose outgoing links are
+considered. For instance, to display a cloud of tags used on blog
+entries, while ignoring other pages that use those tags, you could use:
+ \[[!pagestats pages="tags/*" among="blog/posts/*"]]
+Or to display a cloud of tags related to Linux, you could use:
+ \[[!pagestats pages="tags/* and not tags/linux" among="tagged(linux)"]]
+The optional `show` parameter limits display to the specified number of
+pages. For instance, to show a table of the top ten pages with the most
+ \[[!pagestats style="table" show="10"]]
+The optional `class` parameter can be used to control the class
+of the generated tag cloud `div` or page stats `table`.
+[[!meta robots="noindex, follow"]]