Merge remote-tracking branch 'smcv/pagestats-show'

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

diff --git a/doc/ikiwiki/directive/pagestats.mdwn b/doc/ikiwiki/directive/pagestats.mdwn
index 68f4d2734ad06f1be5c2c379a8953a3a7ac0bb51..ab8397366f985a8604236c597ba8814c8b3aaf01 100644 (file)
--- a/doc/ikiwiki/directive/pagestats.mdwn
+++ b/doc/ikiwiki/directive/pagestats.mdwn
@@ -4,10 +4,16 @@ 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.
 
 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"]]


@@ -20,12 +26,24 @@ entries, while ignoring other pages that use those tags, you could use:
 
 Or to display a cloud of tags related to Linux, you could use:
 
 
 Or to display a cloud of tags related to Linux, you could use:
 

-       \[[!pagestats pages="tags/* and not tags/linux" among="tagged(linux)"]]
+       \[[!pagestats pages="tags/* and !tags/linux" among="tagged(linux)"]]

 
 

-The optional `show` parameter limits display to the specified number of
+The optional `limit` parameter limits display to the specified number of

 pages. For instance, to show a table of the top ten pages with the most
 links:
 
 pages. For instance, to show a table of the top ten pages with the most
 links:
 

-       \[[!pagestats style="table" show="10"]]
+       \[[!pagestats style="table" limit="10"]]
+
+In older versions of IkiWiki this parameter was called `show`;
+that name still works, if its value is numeric.
+
+The optional `class` parameter can be used to control the class
+of the generated tag cloud `div` or page stats `table`.
+
+By default, the names of pages are shown. The `show` parameter
+can be used (with a non-numeric value) to show the titles or descriptions
+of pages instead (as set by the [[meta]] directive). For example:
+
+       \[[!pagestats pages="tags/*" show="title"]]

 
 [[!meta robots="noindex, follow"]]
 
 [[!meta robots="noindex, follow"]]