summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/pagestats.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-07-14 20:25:22 +0200
committerJonas Smedegaard <dr@jones.dk>2010-07-14 20:25:22 +0200
commit90896aac9fcd3ce4b44643a3bc2773a831c0c3cf (patch)
treec7fa66ac8dfb7c475244fa1b2c4ddcdb1bc55375 /ikiwiki/directive/pagestats.mdwn
parent6634fec4377c1d358edc87c3819c280a9e273380 (diff)
Sync with ikiwiki 3.20100704.
Diffstat (limited to 'ikiwiki/directive/pagestats.mdwn')
-rw-r--r--ikiwiki/directive/pagestats.mdwn27
1 files changed, 26 insertions, 1 deletions
diff --git a/ikiwiki/directive/pagestats.mdwn b/ikiwiki/directive/pagestats.mdwn
index cfb5737..d0e0e7b 100644
--- a/ikiwiki/directive/pagestats.mdwn
+++ b/ikiwiki/directive/pagestats.mdwn
@@ -4,12 +4,37 @@ 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:
+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
+cloud.
+
+ \[[!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
+links:
+
+ \[[!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"]]