tag as patch

[git.ikiwiki.info.git] / doc / ikiwiki / directive / pagestats.mdwn

diff --git a/doc/ikiwiki/directive/pagestats.mdwn b/doc/ikiwiki/directive/pagestats.mdwn
index de0419a0338130b17492b3c79f801205e28d7444..68f4d2734ad06f1be5c2c379a8953a3a7ac0bb51 100644 (file)
--- a/doc/ikiwiki/directive/pagestats.mdwn
+++ b/doc/ikiwiki/directive/pagestats.mdwn
@@ -1,4 +1,4 @@
-The `pagestats` directive is supplied by the [[!iki plugins/pagestats]] plugin.
+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
@@ -12,4 +12,20 @@ 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"]]
+
 [[!meta robots="noindex, follow"]]