query

[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..8d904f5a36840011df231c49d49bdd49efa02720 100644 (file)
--- a/doc/ikiwiki/directive/pagestats.mdwn
+++ b/doc/ikiwiki/directive/pagestats.mdwn
@@ -1,15 +1,40 @@
-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
 page.
 
 
 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/*"]]
 
 
        \[[!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"]]
 
 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 !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"]]
 [[!meta robots="noindex, follow"]]